# API Reference ## Constructs ### BitmapDashboard Specific subtype of dashboard that renders supported widgets as bitmaps, while preserving the overall layout. #### Initializers ```typescript import { BitmapDashboard } from 'cdk-monitoring-constructs' new BitmapDashboard(scope: Construct, id: string, props: DashboardProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_cloudwatch.DashboardProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.DashboardProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addVariable | Add a variable to the dashboard. | | addWidgets | Add a widget to the dashboard. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addVariable` ```typescript public addVariable(variable: IVariable): void ``` Add a variable to the dashboard. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_dashboard_variables.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_dashboard_variables.html) ###### `variable`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IVariable --- ##### `addWidgets` ```typescript public addWidgets(widgets: ...IWidget[]): void ``` Add a widget to the dashboard. Widgets given in multiple calls to add() will be laid out stacked on top of each other. Multiple widgets added in the same call to add() will be laid out next to each other. ###### `widgets`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IWidget[] --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### `isConstruct` ```typescript import { BitmapDashboard } from 'cdk-monitoring-constructs' BitmapDashboard.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { BitmapDashboard } from 'cdk-monitoring-constructs' BitmapDashboard.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { BitmapDashboard } from 'cdk-monitoring-constructs' BitmapDashboard.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | dashboardArn | string | ARN of this dashboard. | | dashboardName | string | The name of this dashboard. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `dashboardArn`^Required ```typescript public readonly dashboardArn: string; ``` - *Type:* string ARN of this dashboard. --- ##### `dashboardName`^Required ```typescript public readonly dashboardName: string; ``` - *Type:* string The name of this dashboard. --- ### BitmapWidgetRenderingSupport Support for rendering bitmap widgets on the server side. It is a custom widget lambda with some additional roles and helper methods. #### Initializers ```typescript import { BitmapWidgetRenderingSupport } from 'cdk-monitoring-constructs' new BitmapWidgetRenderingSupport(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | asBitmap | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `asBitmap` ```typescript public asBitmap(widget: IWidget): CustomWidget ``` ###### `widget`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IWidget --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { BitmapWidgetRenderingSupport } from 'cdk-monitoring-constructs' BitmapWidgetRenderingSupport.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | handler | aws-cdk-lib.aws_lambda.IFunction | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `handler`^Required ```typescript public readonly handler: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction --- ### DashboardWithBitmapCopy Composite dashboard which keeps a normal dashboard with its bitmap copy. The bitmap copy name will be derived from the primary dashboard name, if specified. #### Initializers ```typescript import { DashboardWithBitmapCopy } from 'cdk-monitoring-constructs' new DashboardWithBitmapCopy(scope: Construct, id: string, props: DashboardProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_cloudwatch.DashboardProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.DashboardProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addVariable | Add a variable to the dashboard. | | addWidgets | Add a widget to the dashboard. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy: RemovalPolicy): void ``` Apply the given removal policy to this resource. The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced. The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ###### `policy`^Required - *Type:* aws-cdk-lib.RemovalPolicy --- ##### `addVariable` ```typescript public addVariable(variable: IVariable): void ``` Add a variable to the dashboard. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_dashboard_variables.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_dashboard_variables.html) ###### `variable`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IVariable --- ##### `addWidgets` ```typescript public addWidgets(widgets: ...IWidget[]): void ``` Add a widget to the dashboard. Widgets given in multiple calls to add() will be laid out stacked on top of each other. Multiple widgets added in the same call to add() will be laid out next to each other. ###### `widgets`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IWidget[] --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isOwnedResource | Returns true if the construct was created by CDK, and false otherwise. | | isResource | Check whether the given construct is a Resource. | --- ##### `isConstruct` ```typescript import { DashboardWithBitmapCopy } from 'cdk-monitoring-constructs' DashboardWithBitmapCopy.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isOwnedResource` ```typescript import { DashboardWithBitmapCopy } from 'cdk-monitoring-constructs' DashboardWithBitmapCopy.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DashboardWithBitmapCopy } from 'cdk-monitoring-constructs' DashboardWithBitmapCopy.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | dashboardArn | string | ARN of this dashboard. | | dashboardName | string | The name of this dashboard. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this resource is defined. --- ##### `dashboardArn`^Required ```typescript public readonly dashboardArn: string; ``` - *Type:* string ARN of this dashboard. --- ##### `dashboardName`^Required ```typescript public readonly dashboardName: string; ``` - *Type:* string The name of this dashboard. --- ### DefaultDashboardFactory - *Implements:* IDashboardFactory, IDynamicDashboardFactory #### Initializers ```typescript import { DefaultDashboardFactory } from 'cdk-monitoring-constructs' new DefaultDashboardFactory(scope: Construct, id: string, props: MonitoringDashboardsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MonitoringDashboardsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MonitoringDashboardsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addDynamicSegment | Adds a dynamic dashboard segment. | | addSegment | *No description.* | | createdAlarmDashboard | *No description.* | | createdDashboard | *No description.* | | createdSummaryDashboard | *No description.* | | getDashboard | Gets the dashboard for the requested dashboard type. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addDynamicSegment` ```typescript public addDynamicSegment(segment: IDynamicDashboardSegment): void ``` Adds a dynamic dashboard segment. ###### `segment`^Required - *Type:* IDynamicDashboardSegment --- ##### `addSegment` ```typescript public addSegment(props: IDashboardFactoryProps): void ``` ###### `props`^Required - *Type:* IDashboardFactoryProps --- ##### `createdAlarmDashboard` ```typescript public createdAlarmDashboard(): Dashboard ``` ##### `createdDashboard` ```typescript public createdDashboard(): Dashboard ``` ##### `createdSummaryDashboard` ```typescript public createdSummaryDashboard(): Dashboard ``` ##### `getDashboard` ```typescript public getDashboard(name: string): Dashboard ``` Gets the dashboard for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { DefaultDashboardFactory } from 'cdk-monitoring-constructs' DefaultDashboardFactory.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | anyDashboardCreated | boolean | *No description.* | | dashboards | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.Dashboard} | *No description.* | | alarmDashboard | aws-cdk-lib.aws_cloudwatch.Dashboard | *No description.* | | dashboard | aws-cdk-lib.aws_cloudwatch.Dashboard | *No description.* | | summaryDashboard | aws-cdk-lib.aws_cloudwatch.Dashboard | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `anyDashboardCreated`^Required ```typescript public readonly anyDashboardCreated: boolean; ``` - *Type:* boolean --- ##### `dashboards`^Required ```typescript public readonly dashboards: {[ key: string ]: Dashboard}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.Dashboard} --- ##### `alarmDashboard`^Optional ```typescript public readonly alarmDashboard: Dashboard; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Dashboard --- ##### `dashboard`^Optional ```typescript public readonly dashboard: Dashboard; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Dashboard --- ##### `summaryDashboard`^Optional ```typescript public readonly summaryDashboard: Dashboard; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.Dashboard --- ### DynamicDashboardFactory - *Implements:* IDynamicDashboardFactory #### Initializers ```typescript import { DynamicDashboardFactory } from 'cdk-monitoring-constructs' new DynamicDashboardFactory(scope: Construct, id: string, props: MonitoringDynamicDashboardsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MonitoringDynamicDashboardsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* MonitoringDynamicDashboardsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addDynamicSegment | Adds a dynamic dashboard segment. | | getDashboard | Gets the dashboard for the requested dashboard type. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addDynamicSegment` ```typescript public addDynamicSegment(segment: IDynamicDashboardSegment): void ``` Adds a dynamic dashboard segment. ###### `segment`^Required - *Type:* IDynamicDashboardSegment --- ##### `getDashboard` ```typescript public getDashboard(type: string): Dashboard ``` Gets the dashboard for the requested dashboard type. ###### `type`^Required - *Type:* string --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { DynamicDashboardFactory } from 'cdk-monitoring-constructs' DynamicDashboardFactory.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | dashboards | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.Dashboard} | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `dashboards`^Required ```typescript public readonly dashboards: {[ key: string ]: Dashboard}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.Dashboard} --- ### MonitoringFacade An implementation of a {@link MonitoringScope}. This is a convenient main entrypoint to monitor resources. Provides methods for retrieving and creating alarms based on added segments that are subclasses of {@link Monitoring}. #### Initializers ```typescript import { MonitoringFacade } from 'cdk-monitoring-constructs' new MonitoringFacade(scope: Construct, id: string, props?: MonitoringFacadeProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | MonitoringFacadeProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* MonitoringFacadeProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | createAlarmFactory | Creates a new alarm factory. | | createAwsConsoleUrlFactory | Creates a new factory that creates AWS Console URLs. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | addDynamicSegment | Adds a dashboard segment which returns dynamic content depending on dashboard type. | | addLargeHeader | *No description.* | | addMediumHeader | *No description.* | | addSegment | Adds a dashboard segment to go on one of the {@link DefaultDashboards}. | | addSmallHeader | *No description.* | | addWidget | *No description.* | | cloneAlarms | Applies a cloning function to each of the given alarms, creating a new collection of alarms that are adjusted by the function. | | createCompositeAlarmUsingDisambiguator | Finds a subset of created alarms that are marked by a specific disambiguator and creates a composite alarm. | | createCompositeAlarmUsingTag | Finds a subset of created alarms that are marked by a specific custom tag and creates a composite alarm. | | createdAlarmDashboard | *No description.* | | createdAlarms | Returns the created alarms across all added segments that subclass {@link Monitoring} added up until now. | | createdAlarmsWithDisambiguator | Returns a subset of created alarms that are marked by a specific disambiguator. | | createdAlarmsWithTag | Returns a subset of created alarms that are marked by a specific custom tag. | | createdCompositeAlarms | Returns the added composite alarms. | | createdDashboard | *No description.* | | createdDashboardSegments | Returns all the added segments. | | createdMonitorings | Returns the added segments that subclass {@link Monitoring}. | | createdSummaryDashboard | *No description.* | | monitorApiGateway | *No description.* | | monitorApiGatewayV2HttpApi | *No description.* | | monitorAppSyncApi | *No description.* | | monitorAuroraCluster | *No description.* | | monitorAutoScalingGroup | *No description.* | | monitorBilling | *No description.* | | monitorCertificate | *No description.* | | monitorCloudFrontDistribution | *No description.* | | monitorCodeBuildProject | *No description.* | | monitorCustom | *No description.* | | monitorDocumentDbCluster | *No description.* | | monitorDynamoTable | *No description.* | | monitorDynamoTableGlobalSecondaryIndex | *No description.* | | monitorEc2ApplicationLoadBalancer | *No description.* | | monitorEC2Instances | *No description.* | | monitorEc2NetworkLoadBalancer | *No description.* | | monitorEc2Service | *No description.* | | monitorElastiCacheCluster | *No description.* | | monitorElasticsearchCluster | *No description.* | | monitorFargateApplicationLoadBalancer | *No description.* | | monitorFargateNetworkLoadBalancer | *No description.* | | monitorFargateService | *No description.* | | monitorFluentBit | *No description.* | | monitorGlueJob | *No description.* | | monitorKinesisDataAnalytics | *No description.* | | monitorKinesisDataStream | *No description.* | | monitorKinesisDataStreamConsumer | *No description.* | | monitorKinesisFirehose | *No description.* | | monitorLambdaFunction | *No description.* | | monitorLog | *No description.* | | monitorNetworkLoadBalancer | *No description.* | | monitorOpenSearchCluster | *No description.* | | monitorOpenSearchIngestionPipeline | *No description.* | | monitorOpenSearchServerlessCollection | *No description.* | | monitorOpenSearchServerlessIndex | *No description.* | | monitorQueueProcessingEc2Service | *No description.* | | monitorQueueProcessingFargateService | *No description.* | | monitorRdsCluster | *No description.* | | monitorRdsInstance | *No description.* | | monitorRedshiftCluster | *No description.* | | monitorS3Bucket | *No description.* | | monitorScope | Uses an aspect to automatically monitor all resources in the given scope. | | monitorSecretsManager | *No description.* | | monitorSecretsManagerSecret | *No description.* | | monitorServerlessElastiCache | *No description.* | | monitorSimpleEc2Service | *No description.* | | monitorSimpleFargateService | *No description.* | | monitorSnsTopic | *No description.* | | monitorSqsQueue | *No description.* | | monitorSqsQueueWithDlq | *No description.* | | monitorStepFunction | *No description.* | | monitorStepFunctionActivity | *No description.* | | monitorStepFunctionLambdaIntegration | *No description.* | | monitorStepFunctionServiceIntegration | *No description.* | | monitorSyntheticsCanary | *No description.* | | monitorWebApplicationFirewallAclV2 | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string --- ##### `createAwsConsoleUrlFactory` ```typescript public createAwsConsoleUrlFactory(): AwsConsoleUrlFactory ``` Creates a new factory that creates AWS Console URLs. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `addDynamicSegment` ```typescript public addDynamicSegment(segment: IDynamicDashboardSegment): MonitoringFacade ``` Adds a dashboard segment which returns dynamic content depending on dashboard type. ###### `segment`^Required - *Type:* IDynamicDashboardSegment dynamic segment to add. --- ##### `addLargeHeader` ```typescript public addLargeHeader(text: string, addToSummary?: boolean, addToAlarm?: boolean): MonitoringFacade ``` ###### `text`^Required - *Type:* string --- ###### `addToSummary`^Optional - *Type:* boolean --- ###### `addToAlarm`^Optional - *Type:* boolean --- ##### `addMediumHeader` ```typescript public addMediumHeader(text: string, addToSummary?: boolean, addToAlarm?: boolean): MonitoringFacade ``` ###### `text`^Required - *Type:* string --- ###### `addToSummary`^Optional - *Type:* boolean --- ###### `addToAlarm`^Optional - *Type:* boolean --- ##### `addSegment` ```typescript public addSegment(segment: IDashboardSegment, overrideProps?: MonitoringDashboardsOverrideProps): MonitoringFacade ``` Adds a dashboard segment to go on one of the {@link DefaultDashboards}. ###### `segment`^Required - *Type:* IDashboardSegment segment to add. --- ###### `overrideProps`^Optional - *Type:* MonitoringDashboardsOverrideProps props to specify which default dashboards this segment is added to. --- ##### `addSmallHeader` ```typescript public addSmallHeader(text: string, addToSummary?: boolean, addToAlarm?: boolean): MonitoringFacade ``` ###### `text`^Required - *Type:* string --- ###### `addToSummary`^Optional - *Type:* boolean --- ###### `addToAlarm`^Optional - *Type:* boolean --- ##### `addWidget` ```typescript public addWidget(widget: IWidget, addToSummary?: boolean, addToAlarm?: boolean): MonitoringFacade ``` ###### `widget`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IWidget --- ###### `addToSummary`^Optional - *Type:* boolean --- ###### `addToAlarm`^Optional - *Type:* boolean --- ##### `cloneAlarms` ```typescript public cloneAlarms(sourceAlarms: AlarmWithAnnotation[], cloneFunction: AlarmCloneFunction): AlarmWithAnnotation[] ``` Applies a cloning function to each of the given alarms, creating a new collection of alarms that are adjusted by the function. ###### `sourceAlarms`^Required - *Type:* AlarmWithAnnotation[] The alarms that should be used as sources for the clones. --- ###### `cloneFunction`^Required - *Type:* AlarmCloneFunction A function that will accept a source alarm and determine whether and how a new alarm should be cloned from it. --- ##### `createCompositeAlarmUsingDisambiguator` ```typescript public createCompositeAlarmUsingDisambiguator(alarmDisambiguator: string, props?: AddCompositeAlarmProps): CompositeAlarm ``` Finds a subset of created alarms that are marked by a specific disambiguator and creates a composite alarm. This composite alarm is created with an 'OR' condition, so it triggers with any child alarm. NOTE: This composite alarm is not added among other alarms, so it is not returned by createdAlarms() calls. ###### `alarmDisambiguator`^Required - *Type:* string disambiguator to filter alarms by. --- ###### `props`^Optional - *Type:* AddCompositeAlarmProps customization options. --- ##### `createCompositeAlarmUsingTag` ```typescript public createCompositeAlarmUsingTag(customTag: string, props?: AddCompositeAlarmProps): CompositeAlarm ``` Finds a subset of created alarms that are marked by a specific custom tag and creates a composite alarm. This composite alarm is created with an 'OR' condition, so it triggers with any child alarm. NOTE: This composite alarm is not added among other alarms, so it is not returned by createdAlarms() calls. ###### `customTag`^Required - *Type:* string tag to filter alarms by. --- ###### `props`^Optional - *Type:* AddCompositeAlarmProps customization options. --- ##### ~~`createdAlarmDashboard`~~ ```typescript public createdAlarmDashboard(): Dashboard ``` ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns the created alarms across all added segments that subclass {@link Monitoring} added up until now. ##### `createdAlarmsWithDisambiguator` ```typescript public createdAlarmsWithDisambiguator(disambiguator: string): AlarmWithAnnotation[] ``` Returns a subset of created alarms that are marked by a specific disambiguator. ###### `disambiguator`^Required - *Type:* string disambiguator to filter alarms by. --- ##### `createdAlarmsWithTag` ```typescript public createdAlarmsWithTag(customTag: string): AlarmWithAnnotation[] ``` Returns a subset of created alarms that are marked by a specific custom tag. ###### `customTag`^Required - *Type:* string tag to filter alarms by. --- ##### `createdCompositeAlarms` ```typescript public createdCompositeAlarms(): CompositeAlarm[] ``` Returns the added composite alarms. ##### ~~`createdDashboard`~~ ```typescript public createdDashboard(): Dashboard ``` ##### `createdDashboardSegments` ```typescript public createdDashboardSegments(): (IDashboardSegment | IDynamicDashboardSegment)[] ``` Returns all the added segments. ##### `createdMonitorings` ```typescript public createdMonitorings(): Monitoring[] ``` Returns the added segments that subclass {@link Monitoring}. ##### ~~`createdSummaryDashboard`~~ ```typescript public createdSummaryDashboard(): Dashboard ``` ##### `monitorApiGateway` ```typescript public monitorApiGateway(props: ApiGatewayMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* ApiGatewayMonitoringProps --- ##### `monitorApiGatewayV2HttpApi` ```typescript public monitorApiGatewayV2HttpApi(props: ApiGatewayV2HttpApiMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* ApiGatewayV2HttpApiMonitoringProps --- ##### `monitorAppSyncApi` ```typescript public monitorAppSyncApi(props: AppSyncMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* AppSyncMonitoringProps --- ##### `monitorAuroraCluster` ```typescript public monitorAuroraCluster(props: AuroraClusterMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* AuroraClusterMonitoringProps --- ##### `monitorAutoScalingGroup` ```typescript public monitorAutoScalingGroup(props: AutoScalingGroupMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* AutoScalingGroupMonitoringProps --- ##### `monitorBilling` ```typescript public monitorBilling(props?: BillingMonitoringProps): MonitoringFacade ``` ###### `props`^Optional - *Type:* BillingMonitoringProps --- ##### `monitorCertificate` ```typescript public monitorCertificate(props: CertificateManagerMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* CertificateManagerMonitoringProps --- ##### `monitorCloudFrontDistribution` ```typescript public monitorCloudFrontDistribution(props: CloudFrontDistributionMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* CloudFrontDistributionMonitoringProps --- ##### `monitorCodeBuildProject` ```typescript public monitorCodeBuildProject(props: CodeBuildProjectMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* CodeBuildProjectMonitoringProps --- ##### `monitorCustom` ```typescript public monitorCustom(props: CustomMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* CustomMonitoringProps --- ##### `monitorDocumentDbCluster` ```typescript public monitorDocumentDbCluster(props: DocumentDbMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* DocumentDbMonitoringProps --- ##### `monitorDynamoTable` ```typescript public monitorDynamoTable(props: DynamoTableMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* DynamoTableMonitoringProps --- ##### `monitorDynamoTableGlobalSecondaryIndex` ```typescript public monitorDynamoTableGlobalSecondaryIndex(props: DynamoTableGlobalSecondaryIndexMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* DynamoTableGlobalSecondaryIndexMonitoringProps --- ##### `monitorEc2ApplicationLoadBalancer` ```typescript public monitorEc2ApplicationLoadBalancer(props: Ec2ApplicationLoadBalancerMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* Ec2ApplicationLoadBalancerMonitoringProps --- ##### `monitorEC2Instances` ```typescript public monitorEC2Instances(props: EC2MonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* EC2MonitoringProps --- ##### `monitorEc2NetworkLoadBalancer` ```typescript public monitorEc2NetworkLoadBalancer(props: Ec2NetworkLoadBalancerMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* Ec2NetworkLoadBalancerMonitoringProps --- ##### `monitorEc2Service` ```typescript public monitorEc2Service(props: Ec2ServiceMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* Ec2ServiceMonitoringProps --- ##### `monitorElastiCacheCluster` ```typescript public monitorElastiCacheCluster(props: ElastiCacheClusterMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* ElastiCacheClusterMonitoringProps --- ##### `monitorElasticsearchCluster` ```typescript public monitorElasticsearchCluster(props: OpenSearchClusterMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* OpenSearchClusterMonitoringProps --- ##### `monitorFargateApplicationLoadBalancer` ```typescript public monitorFargateApplicationLoadBalancer(props: FargateApplicationLoadBalancerMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* FargateApplicationLoadBalancerMonitoringProps --- ##### `monitorFargateNetworkLoadBalancer` ```typescript public monitorFargateNetworkLoadBalancer(props: FargateNetworkLoadBalancerMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* FargateNetworkLoadBalancerMonitoringProps --- ##### `monitorFargateService` ```typescript public monitorFargateService(props: FargateServiceMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* FargateServiceMonitoringProps --- ##### `monitorFluentBit` ```typescript public monitorFluentBit(props: FluentBitMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* FluentBitMonitoringProps --- ##### `monitorGlueJob` ```typescript public monitorGlueJob(props: GlueJobMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* GlueJobMonitoringProps --- ##### `monitorKinesisDataAnalytics` ```typescript public monitorKinesisDataAnalytics(props: KinesisDataAnalyticsMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* KinesisDataAnalyticsMonitoringProps --- ##### `monitorKinesisDataStream` ```typescript public monitorKinesisDataStream(props: KinesisDataStreamMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* KinesisDataStreamMonitoringProps --- ##### `monitorKinesisDataStreamConsumer` ```typescript public monitorKinesisDataStreamConsumer(props: KinesisDataStreamConsumerMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* KinesisDataStreamConsumerMonitoringProps --- ##### `monitorKinesisFirehose` ```typescript public monitorKinesisFirehose(props: KinesisFirehoseMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* KinesisFirehoseMonitoringProps --- ##### `monitorLambdaFunction` ```typescript public monitorLambdaFunction(props: LambdaFunctionMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* LambdaFunctionMonitoringProps --- ##### `monitorLog` ```typescript public monitorLog(props: LogMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* LogMonitoringProps --- ##### `monitorNetworkLoadBalancer` ```typescript public monitorNetworkLoadBalancer(props: NetworkLoadBalancerMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* NetworkLoadBalancerMonitoringProps --- ##### `monitorOpenSearchCluster` ```typescript public monitorOpenSearchCluster(props: OpenSearchClusterMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* OpenSearchClusterMonitoringProps --- ##### `monitorOpenSearchIngestionPipeline` ```typescript public monitorOpenSearchIngestionPipeline(props: OpenSearchIngestionPipelineMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* OpenSearchIngestionPipelineMonitoringProps --- ##### `monitorOpenSearchServerlessCollection` ```typescript public monitorOpenSearchServerlessCollection(props: OpenSearchServerlessMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* OpenSearchServerlessMonitoringProps --- ##### `monitorOpenSearchServerlessIndex` ```typescript public monitorOpenSearchServerlessIndex(props: OpenSearchServerlessIndexMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* OpenSearchServerlessIndexMonitoringProps --- ##### `monitorQueueProcessingEc2Service` ```typescript public monitorQueueProcessingEc2Service(props: QueueProcessingEc2ServiceMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* QueueProcessingEc2ServiceMonitoringProps --- ##### `monitorQueueProcessingFargateService` ```typescript public monitorQueueProcessingFargateService(props: QueueProcessingFargateServiceMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* QueueProcessingFargateServiceMonitoringProps --- ##### `monitorRdsCluster` ```typescript public monitorRdsCluster(props: RdsClusterMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* RdsClusterMonitoringProps --- ##### `monitorRdsInstance` ```typescript public monitorRdsInstance(props: RdsInstanceMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* RdsInstanceMonitoringProps --- ##### `monitorRedshiftCluster` ```typescript public monitorRedshiftCluster(props: RedshiftClusterMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* RedshiftClusterMonitoringProps --- ##### `monitorS3Bucket` ```typescript public monitorS3Bucket(props: S3BucketMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* S3BucketMonitoringProps --- ##### `monitorScope` ```typescript public monitorScope(scope: Construct, aspectProps?: MonitoringAspectProps): MonitoringFacade ``` Uses an aspect to automatically monitor all resources in the given scope. ###### `scope`^Required - *Type:* constructs.Construct Scope with resources to monitor. --- ###### `aspectProps`^Optional - *Type:* MonitoringAspectProps Optional configuration. --- ##### `monitorSecretsManager` ```typescript public monitorSecretsManager(props: SecretsManagerMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* SecretsManagerMonitoringProps --- ##### `monitorSecretsManagerSecret` ```typescript public monitorSecretsManagerSecret(props: SecretsManagerSecretMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* SecretsManagerSecretMonitoringProps --- ##### `monitorServerlessElastiCache` ```typescript public monitorServerlessElastiCache(props: ElastiCacheServerlessMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* ElastiCacheServerlessMonitoringProps --- ##### `monitorSimpleEc2Service` ```typescript public monitorSimpleEc2Service(props: SimpleEc2ServiceMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* SimpleEc2ServiceMonitoringProps --- ##### `monitorSimpleFargateService` ```typescript public monitorSimpleFargateService(props: SimpleFargateServiceMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* SimpleFargateServiceMonitoringProps --- ##### `monitorSnsTopic` ```typescript public monitorSnsTopic(props: SnsTopicMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* SnsTopicMonitoringProps --- ##### `monitorSqsQueue` ```typescript public monitorSqsQueue(props: SqsQueueMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* SqsQueueMonitoringProps --- ##### `monitorSqsQueueWithDlq` ```typescript public monitorSqsQueueWithDlq(props: SqsQueueMonitoringWithDlqProps): MonitoringFacade ``` ###### `props`^Required - *Type:* SqsQueueMonitoringWithDlqProps --- ##### `monitorStepFunction` ```typescript public monitorStepFunction(props: StepFunctionMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* StepFunctionMonitoringProps --- ##### `monitorStepFunctionActivity` ```typescript public monitorStepFunctionActivity(props: StepFunctionActivityMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* StepFunctionActivityMonitoringProps --- ##### `monitorStepFunctionLambdaIntegration` ```typescript public monitorStepFunctionLambdaIntegration(props: StepFunctionLambdaIntegrationMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* StepFunctionLambdaIntegrationMonitoringProps --- ##### `monitorStepFunctionServiceIntegration` ```typescript public monitorStepFunctionServiceIntegration(props: StepFunctionServiceIntegrationMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* StepFunctionServiceIntegrationMonitoringProps --- ##### `monitorSyntheticsCanary` ```typescript public monitorSyntheticsCanary(props: SyntheticsCanaryMonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* SyntheticsCanaryMonitoringProps --- ##### `monitorWebApplicationFirewallAclV2` ```typescript public monitorWebApplicationFirewallAclV2(props: WafV2MonitoringProps): MonitoringFacade ``` ###### `props`^Required - *Type:* WafV2MonitoringProps --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { MonitoringFacade } from 'cdk-monitoring-constructs' MonitoringFacade.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | dashboardFactory | IDynamicDashboardFactory | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `dashboardFactory`^Optional ```typescript public readonly dashboardFactory: IDynamicDashboardFactory; ``` - *Type:* IDynamicDashboardFactory --- ### MonitoringScope A scope where all monitored constructs are managed from (i.e., alarms, dashboards, etc.). Standard usages will use {@link MonitoringFacade }. #### Initializers ```typescript import { MonitoringScope } from 'cdk-monitoring-constructs' new MonitoringScope(scope: Construct, id: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | The scope in which to define this construct. | | id | string | The scoped construct ID. | --- ##### `scope`^Required - *Type:* constructs.Construct The scope in which to define this construct. --- ##### `id`^Required - *Type:* string The scoped construct ID. Must be unique amongst siblings. If the ID includes a path separator (`/`), then it will be replaced by double dash `--`. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | createAlarmFactory | Creates a new alarm factory. | | createAwsConsoleUrlFactory | Creates a new factory that creates AWS Console URLs. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createAwsConsoleUrlFactory` ```typescript public createAwsConsoleUrlFactory(): AwsConsoleUrlFactory ``` Creates a new factory that creates AWS Console URLs. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { MonitoringScope } from 'cdk-monitoring-constructs' MonitoringScope.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ### SecretsManagerMetricsPublisher #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | addSecret | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `addSecret` ```typescript public addSecret(secret: ISecret): void ``` ###### `secret`^Required - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | getInstance | *No description.* | --- ##### `isConstruct` ```typescript import { SecretsManagerMetricsPublisher } from 'cdk-monitoring-constructs' SecretsManagerMetricsPublisher.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `getInstance` ```typescript import { SecretsManagerMetricsPublisher } from 'cdk-monitoring-constructs' SecretsManagerMetricsPublisher.getInstance(scope: MonitoringScope) ``` ###### `scope`^Required - *Type:* MonitoringScope --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | lambda | aws-cdk-lib.aws_lambda.IFunction | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `lambda`^Required ```typescript public readonly lambda: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction --- ## Structs ### AddAlarmProps Properties necessary to create a single alarm and configure it. #### Initializer ```typescript import { AddAlarmProps } from 'cdk-monitoring-constructs' const addAlarmProps: AddAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmDescription | string | Alarm description is included in the ticket and therefore should describe what happened, with as much context as possible. | | alarmNameSuffix | string | Suffix added to base alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | Comparison operator used to compare actual value against the threshold. | | threshold | number | Threshold to alarm on. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | actionOverride | IAlarmActionStrategy | Allows to override the default action strategy. | | actionsEnabled | boolean | Enables the configured CloudWatch alarm ticketing actions. | | alarmDedupeStringSuffix | string | If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. | | alarmDescriptionOverride | string | A text included in the generated ticket description body, which fully replaces the generated text. | | alarmNameOverride | string | If this is defined, the alarm name is set to this exact value. | | customParams | {[ key: string ]: any} | This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | customTags | string[] | This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | datapointsToAlarm | number | Number of breaches required to transition into an ALARM state. | | dedupeStringOverride | string | If this is defined, the alarm dedupe string is set to this exact value. | | disambiguator | string | Disambiguator is a string that differentiates this alarm from other similar ones. | | documentationLink | string | An optional link included in the generated ticket description body. | | evaluateLowSampleCountPercentile | boolean | Used only for alarms based on percentiles. | | evaluationPeriods | number | Number of periods to consider when checking the number of breaching datapoints. | | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | | minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | sampleCountMetricId | string | This property is required in the following situation:

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | --- ##### `alarmDescription`^Required ```typescript public readonly alarmDescription: string; ``` - *Type:* string Alarm description is included in the ticket and therefore should describe what happened, with as much context as possible. --- ##### `alarmNameSuffix`^Required ```typescript public readonly alarmNameSuffix: string; ``` - *Type:* string Suffix added to base alarm name. Alarm names need to be unique. --- ##### `comparisonOperator`^Required ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator Comparison operator used to compare actual value against the threshold. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Threshold to alarm on. --- ##### `treatMissingData`^Required ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData Behaviour in case the metric data is missing. --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* default action will be used Allows to override the default action strategy. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as alarmDedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `disambiguator`^Optional ```typescript public readonly disambiguator: string; ``` - *Type:* string - *Default:* undefined (no disambiguator) Disambiguator is a string that differentiates this alarm from other similar ones. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* Same as datapointsToAlarm. Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, an artificial composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

The newly created composite alarm will be returned as a result, and it will take the original alarm actions. --- ##### `minSampleCountToEvaluateDatapoint`^Optional ```typescript public readonly minSampleCountToEvaluateDatapoint: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be used Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. If this property is specified, your metric will be subject to MathExpression that will add an IF condition to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated according to the treatMissingData parameter. If specified, deprecated minMetricSamplesToAlarm has no effect. --- ##### `overrideAnnotationColor`^Optional ```typescript public readonly overrideAnnotationColor: string; ``` - *Type:* string - *Default:* no override (default color) If specified, it modifies the final alarm annotation color. --- ##### `overrideAnnotationLabel`^Optional ```typescript public readonly overrideAnnotationLabel: string; ``` - *Type:* string - *Default:* no override (default label) If specified, it modifies the final alarm annotation label. --- ##### `overrideAnnotationVisibility`^Optional ```typescript public readonly overrideAnnotationVisibility: boolean; ``` - *Type:* boolean - *Default:* no override (default visibility) If specified, it modifies the final alarm annotation visibility. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* the default specified in MetricFactory Period override for the metric to alarm on. --- ##### `runbookLink`^Optional ```typescript public readonly runbookLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `sampleCountMetricId`^Optional ```typescript public readonly sampleCountMetricId: string; ``` - *Type:* string This property is required in the following situation:

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | alarmWhenAboveTheBand | boolean | *No description.* | | alarmWhenBelowTheBand | boolean | *No description.* | | standardDeviationForAlarm | number | *No description.* | | additionalDescription | string | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

This composite alarm will be returned as a result and uses the specified alarm actions. --- ##### `minSampleCountToEvaluateDatapoint`^Optional ```typescript public readonly minSampleCountToEvaluateDatapoint: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be used Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. If this property is specified, your metric will be subject to MathExpression that will add an IF condition to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated according to the treatMissingData parameter. If specified, deprecated minMetricSamplesToAlarm has no effect. --- ##### `overrideAnnotationColor`^Optional ```typescript public readonly overrideAnnotationColor: string; ``` - *Type:* string - *Default:* no override (default color) If specified, it modifies the final alarm annotation color. --- ##### `overrideAnnotationLabel`^Optional ```typescript public readonly overrideAnnotationLabel: string; ``` - *Type:* string - *Default:* no override (default label) If specified, it modifies the final alarm annotation label. --- ##### `overrideAnnotationVisibility`^Optional ```typescript public readonly overrideAnnotationVisibility: boolean; ``` - *Type:* boolean - *Default:* no override (default visibility) If specified, it modifies the final alarm annotation visibility. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* the default specified in MetricFactory Period override for the metric to alarm on. --- ##### `runbookLink`^Optional ```typescript public readonly runbookLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `sampleCountMetricId`^Optional ```typescript public readonly sampleCountMetricId: string; ``` - *Type:* string This property is required in the following situation:

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minAvailabilityPercent | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | alarmWhenDecreased | boolean | *No description.* | | alarmWhenIncreased | boolean | *No description.* | | requiredSecretCount | number | *No description.* | | additionalDescription | string | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxConsumedCapacityUnits | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxRateExceeded | number | Threshold for SubscribeToShard.RateExceeded average (0.0–1.0). | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancer \| aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer

| *No description.* | | targetGroup |

aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup \| aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup

| *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addCpuP100UsageAlarm`^Optional ```typescript public readonly addCpuP100UsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addCpuUsageAlarm`^Optional ```typescript public readonly addCpuUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addEphermalStorageUsageAlarm`^Optional ```typescript public readonly addEphermalStorageUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} Container Insights needs to be enabled for the cluster for this alarm. --- ##### `addMemoryP100UsageAlarm`^Optional ```typescript public readonly addMemoryP100UsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addMemoryUsageAlarm`^Optional ```typescript public readonly addMemoryUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addRunningTaskCountAlarm`^Optional ```typescript public readonly addRunningTaskCountAlarm: {[ key: string ]: RunningTaskCountThreshold}; ``` - *Type:* {[ key: string ]: RunningTaskCountThreshold} Container Insights needs to be enabled for the cluster for this alarm. --- ##### `maxAutoScalingTaskCount`^Optional ```typescript public readonly maxAutoScalingTaskCount: number; ``` - *Type:* number Maximum number of tasks, as specified in your auto scaling config. --- ##### `minAutoScalingTaskCount`^Optional ```typescript public readonly minAutoScalingTaskCount: number; ``` - *Type:* number Minimum number of tasks, as specified in your auto scaling config. --- ##### `ec2Service`^Required ```typescript public readonly ec2Service: IBaseService; ``` - *Type:* aws-cdk-lib.aws_ecs.IBaseService --- ##### `addHealthyTaskCountAlarm`^Optional ```typescript public readonly addHealthyTaskCountAlarm: {[ key: string ]: HealthyTaskCountThreshold}; ``` - *Type:* {[ key: string ]: HealthyTaskCountThreshold} --- ##### `addHealthyTaskPercentAlarm`^Optional ```typescript public readonly addHealthyTaskPercentAlarm: {[ key: string ]: HealthyTaskPercentThreshold}; ``` - *Type:* {[ key: string ]: HealthyTaskPercentThreshold} --- ##### `addMinProcessedBytesAlarm`^Optional ```typescript public readonly addMinProcessedBytesAlarm: {[ key: string ]: MinProcessedBytesThreshold}; ``` - *Type:* {[ key: string ]: MinProcessedBytesThreshold} --- ##### `addUnhealthyTaskCountAlarm`^Optional ```typescript public readonly addUnhealthyTaskCountAlarm: {[ key: string ]: UnhealthyTaskCountThreshold}; ``` - *Type:* {[ key: string ]: UnhealthyTaskCountThreshold} --- ##### `invertLoadBalancerTaskCountMetricsStatistics`^Optional ```typescript public readonly invertLoadBalancerTaskCountMetricsStatistics: boolean; ``` - *Type:* boolean - *Default:* false Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`. When `invertLoadBalancerTaskCountMetricsStatistics` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored. When `invertLoadBalancerTaskCountMetricsStatistics` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored. `invertLoadBalancerTaskCountMetricsStatistics` is recommended to set to true as per the guidelines at https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics --- ##### `loadBalancer`^Optional ```typescript public readonly loadBalancer: INetworkLoadBalancer | IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer --- ##### `targetGroup`^Optional ```typescript public readonly targetGroup: INetworkTargetGroup | IApplicationTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup --- ### CustomFargateServiceMonitoringProps #### Initializer ```typescript import { CustomFargateServiceMonitoringProps } from 'cdk-monitoring-constructs' const customFargateServiceMonitoringProps: CustomFargateServiceMonitoringProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | addCpuP100UsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addCpuUsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addEphermalStorageUsageAlarm | {[ key: string ]: UsageThreshold} | Container Insights needs to be enabled for the cluster for this alarm. | | addMemoryP100UsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addMemoryUsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addRunningTaskCountAlarm | {[ key: string ]: RunningTaskCountThreshold} | Container Insights needs to be enabled for the cluster for this alarm. | | maxAutoScalingTaskCount | number | Maximum number of tasks, as specified in your auto scaling config. | | minAutoScalingTaskCount | number | Minimum number of tasks, as specified in your auto scaling config. | | addHealthyTaskCountAlarm | {[ key: string ]: HealthyTaskCountThreshold} | *No description.* | | addHealthyTaskPercentAlarm | {[ key: string ]: HealthyTaskPercentThreshold} | *No description.* | | addMinProcessedBytesAlarm | {[ key: string ]: MinProcessedBytesThreshold} | *No description.* | | addUnhealthyTaskCountAlarm | {[ key: string ]: UnhealthyTaskCountThreshold} | *No description.* | | invertLoadBalancerTaskCountMetricsStatistics | boolean | Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`. | | fargateService | aws-cdk-lib.aws_ecs.IBaseService | *No description.* | | loadBalancer |

aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancer \| aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer

| *No description.* | | targetGroup |

aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup \| aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup

| *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addCpuP100UsageAlarm`^Optional ```typescript public readonly addCpuP100UsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addCpuUsageAlarm`^Optional ```typescript public readonly addCpuUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addEphermalStorageUsageAlarm`^Optional ```typescript public readonly addEphermalStorageUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} Container Insights needs to be enabled for the cluster for this alarm. --- ##### `addMemoryP100UsageAlarm`^Optional ```typescript public readonly addMemoryP100UsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addMemoryUsageAlarm`^Optional ```typescript public readonly addMemoryUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addRunningTaskCountAlarm`^Optional ```typescript public readonly addRunningTaskCountAlarm: {[ key: string ]: RunningTaskCountThreshold}; ``` - *Type:* {[ key: string ]: RunningTaskCountThreshold} Container Insights needs to be enabled for the cluster for this alarm. --- ##### `maxAutoScalingTaskCount`^Optional ```typescript public readonly maxAutoScalingTaskCount: number; ``` - *Type:* number Maximum number of tasks, as specified in your auto scaling config. --- ##### `minAutoScalingTaskCount`^Optional ```typescript public readonly minAutoScalingTaskCount: number; ``` - *Type:* number Minimum number of tasks, as specified in your auto scaling config. --- ##### `addHealthyTaskCountAlarm`^Optional ```typescript public readonly addHealthyTaskCountAlarm: {[ key: string ]: HealthyTaskCountThreshold}; ``` - *Type:* {[ key: string ]: HealthyTaskCountThreshold} --- ##### `addHealthyTaskPercentAlarm`^Optional ```typescript public readonly addHealthyTaskPercentAlarm: {[ key: string ]: HealthyTaskPercentThreshold}; ``` - *Type:* {[ key: string ]: HealthyTaskPercentThreshold} --- ##### `addMinProcessedBytesAlarm`^Optional ```typescript public readonly addMinProcessedBytesAlarm: {[ key: string ]: MinProcessedBytesThreshold}; ``` - *Type:* {[ key: string ]: MinProcessedBytesThreshold} --- ##### `addUnhealthyTaskCountAlarm`^Optional ```typescript public readonly addUnhealthyTaskCountAlarm: {[ key: string ]: UnhealthyTaskCountThreshold}; ``` - *Type:* {[ key: string ]: UnhealthyTaskCountThreshold} --- ##### `invertLoadBalancerTaskCountMetricsStatistics`^Optional ```typescript public readonly invertLoadBalancerTaskCountMetricsStatistics: boolean; ``` - *Type:* boolean - *Default:* false Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`. When `invertLoadBalancerTaskCountMetricsStatistics` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored. When `invertLoadBalancerTaskCountMetricsStatistics` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored. `invertLoadBalancerTaskCountMetricsStatistics` is recommended to set to true as per the guidelines at https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics --- ##### `fargateService`^Required ```typescript public readonly fargateService: IBaseService; ``` - *Type:* aws-cdk-lib.aws_ecs.IBaseService --- ##### `loadBalancer`^Optional ```typescript public readonly loadBalancer: INetworkLoadBalancer | IApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancer --- ##### `targetGroup`^Optional ```typescript public readonly targetGroup: INetworkTargetGroup | IApplicationTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup --- ### CustomMetricGroup Custom metric group represents a single widget. #### Initializer ```typescript import { CustomMetricGroup } from 'cdk-monitoring-constructs' const customMetricGroup: CustomMetricGroup = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metrics |

aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric \| CustomMetricWithAlarm \| CustomMetricWithAnomalyDetection \| CustomMetricSearch[]

| list of metrics in the group (can be defined in different ways, see the type documentation). | | title | string | title of the whole group. | | addToSummaryDashboard | boolean | Flag indicating this metric group should be included in the summary as well. | | graphWidgetAxis | aws-cdk-lib.aws_cloudwatch.YAxisProps | optional axis. | | graphWidgetLegend | aws-cdk-lib.aws_cloudwatch.LegendPosition | graph widget legend. | | graphWidgetRightAxis | aws-cdk-lib.aws_cloudwatch.YAxisProps | optional right axis. | | graphWidgetSetPeriodToTimeRange | boolean | *No description.* | | graphWidgetType | GraphWidgetType | type of the widget. | | graphWidgetWidth | number | Width of graph widget. | | horizontalAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | Optional custom horizontal annotations which will be displayed over the metrics on the left axis (if there are any alarms, any existing annotations will be merged together). | | horizontalRightAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | Optional custom horizontal annotations which will be displayed over the metrics on the right axis (if there are any alarms, any existing annotations will be merged together). | | important | boolean | *No description.* | | verticalAnnotations | aws-cdk-lib.aws_cloudwatch.VerticalAnnotation[] | Optional custom vertical annotations which will be displayed over the metrics. | --- ##### `metrics`^Required ```typescript public readonly metrics: (MathExpression | Metric | CustomMetricWithAlarm | CustomMetricWithAnomalyDetection | CustomMetricSearch)[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric | CustomMetricWithAlarm | CustomMetricWithAnomalyDetection | CustomMetricSearch[] list of metrics in the group (can be defined in different ways, see the type documentation). --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string title of the whole group. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* addToSummaryDashboard from CustomMonitoringProps, defaulting to false Flag indicating this metric group should be included in the summary as well. --- ##### `graphWidgetAxis`^Optional ```typescript public readonly graphWidgetAxis: YAxisProps; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.YAxisProps - *Default:* undefined optional axis. --- ##### `graphWidgetLegend`^Optional ```typescript public readonly graphWidgetLegend: LegendPosition; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.LegendPosition - *Default:* BOTTOM graph widget legend. --- ##### `graphWidgetRightAxis`^Optional ```typescript public readonly graphWidgetRightAxis: YAxisProps; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.YAxisProps - *Default:* undefined optional right axis. --- ##### `graphWidgetSetPeriodToTimeRange`^Optional ```typescript public readonly graphWidgetSetPeriodToTimeRange: boolean; ``` - *Type:* boolean > [{GraphWidgetProps.setPeriodToTimeRange}]({GraphWidgetProps.setPeriodToTimeRange}) --- ##### `graphWidgetType`^Optional ```typescript public readonly graphWidgetType: GraphWidgetType; ``` - *Type:* GraphWidgetType - *Default:* line type of the widget. --- ##### `graphWidgetWidth`^Optional ```typescript public readonly graphWidgetWidth: number; ``` - *Type:* number - *Default:* Automatically calculcated width, generally as wide as possible considering all metrics' widgets. Width of graph widget. Note that widgets will overflow into new rows if the summed width exceeds 24. --- ##### `horizontalAnnotations`^Optional ```typescript public readonly horizontalAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] Optional custom horizontal annotations which will be displayed over the metrics on the left axis (if there are any alarms, any existing annotations will be merged together). --- ##### `horizontalRightAnnotations`^Optional ```typescript public readonly horizontalRightAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] Optional custom horizontal annotations which will be displayed over the metrics on the right axis (if there are any alarms, any existing annotations will be merged together). --- ##### ~~`important`~~^Optional - *Deprecated:* use addToSummaryDashboard. addToSummaryDashboard will take precedence over important. ```typescript public readonly important: boolean; ``` - *Type:* boolean > [addToSummaryDashboard](addToSummaryDashboard) --- ##### `verticalAnnotations`^Optional ```typescript public readonly verticalAnnotations: VerticalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.VerticalAnnotation[] Optional custom vertical annotations which will be displayed over the metrics. --- ### CustomMetricGroupWithAnnotations #### Initializer ```typescript import { CustomMetricGroupWithAnnotations } from 'cdk-monitoring-constructs' const customMetricGroupWithAnnotations: CustomMetricGroupWithAnnotations = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | annotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | metricGroup | CustomMetricGroup | *No description.* | | rightAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | titleAddons | string[] | *No description.* | | verticalAnnotations | aws-cdk-lib.aws_cloudwatch.VerticalAnnotation[] | *No description.* | | height | number | *No description.* | --- ##### `annotations`^Required ```typescript public readonly annotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `metricGroup`^Required ```typescript public readonly metricGroup: CustomMetricGroup; ``` - *Type:* CustomMetricGroup --- ##### `rightAnnotations`^Required ```typescript public readonly rightAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `titleAddons`^Required ```typescript public readonly titleAddons: string[]; ``` - *Type:* string[] --- ##### `verticalAnnotations`^Required ```typescript public readonly verticalAnnotations: VerticalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.VerticalAnnotation[] --- ##### `height`^Optional ```typescript public readonly height: number; ``` - *Type:* number --- ### CustomMetricSearch Custom metric search. #### Initializer ```typescript import { CustomMetricSearch } from 'cdk-monitoring-constructs' const customMetricSearch: CustomMetricSearch = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dimensionsMap | {[ key: string ]: string} | search dimensions (can be empty). | | searchQuery | string | search query (can be empty). | | statistic | MetricStatistic | metric statistic. | | account | string | Account which this metric comes from. | | label | string | custom label for the metrics. | | namespace | string | metric namespace. | | period | aws-cdk-lib.Duration | metric period. | | position | AxisPosition | axis (right or left) on which to graph metric default: AxisPosition.LEFT. | | region | string | Region which this metric comes from. | --- ##### `dimensionsMap`^Required ```typescript public readonly dimensionsMap: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} search dimensions (can be empty). --- ##### `searchQuery`^Required ```typescript public readonly searchQuery: string; ``` - *Type:* string search query (can be empty). --- ##### `statistic`^Required ```typescript public readonly statistic: MetricStatistic; ``` - *Type:* MetricStatistic metric statistic. --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* Deployment account. Account which this metric comes from. Note that alarms cannot be created for cross-account metrics. --- ##### `label`^Optional ```typescript public readonly label: string; ``` - *Type:* string - *Default:* " " custom label for the metrics. --- ##### `namespace`^Optional ```typescript public readonly namespace: string; ``` - *Type:* string - *Default:* none metric namespace. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* global default metric period. --- ##### `position`^Optional ```typescript public readonly position: AxisPosition; ``` - *Type:* AxisPosition axis (right or left) on which to graph metric default: AxisPosition.LEFT. --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* Deployment region. Region which this metric comes from. Note that alarms cannot be created for cross-region metrics. --- ### CustomMetricWithAlarm Custom metric with an alarm defined. #### Initializer ```typescript import { CustomMetricWithAlarm } from 'cdk-monitoring-constructs' const customMetricWithAlarm: CustomMetricWithAlarm = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | addAlarm | {[ key: string ]: CustomThreshold} | alarm definitions. | | alarmFriendlyName | string | alarm friendly name. | | metric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | metric to alarm on. | | position | AxisPosition | axis (right or left) on which to graph metric default: AxisPosition.LEFT. | --- ##### `addAlarm`^Required ```typescript public readonly addAlarm: {[ key: string ]: CustomThreshold}; ``` - *Type:* {[ key: string ]: CustomThreshold} alarm definitions. --- ##### `alarmFriendlyName`^Required ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string alarm friendly name. --- ##### `metric`^Required ```typescript public readonly metric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric metric to alarm on. --- ##### `position`^Optional ```typescript public readonly position: AxisPosition; ``` - *Type:* AxisPosition axis (right or left) on which to graph metric default: AxisPosition.LEFT. --- ### CustomMetricWithAnomalyDetection Custom metric with anomaly detection. #### Initializer ```typescript import { CustomMetricWithAnomalyDetection } from 'cdk-monitoring-constructs' const customMetricWithAnomalyDetection: CustomMetricWithAnomalyDetection = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFriendlyName | string | alarm friendly name. | | anomalyDetectionStandardDeviationToRender | number | standard deviation for the anomaly detection to be rendered on the graph widget. | | metric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | metric to alarm on. | | addAlarmOnAnomaly | {[ key: string ]: AnomalyDetectionThreshold} | adds alarm on a detected anomaly. | | period | aws-cdk-lib.Duration | anomaly detection period. | --- ##### `alarmFriendlyName`^Required ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string alarm friendly name. --- ##### `anomalyDetectionStandardDeviationToRender`^Required ```typescript public readonly anomalyDetectionStandardDeviationToRender: number; ``` - *Type:* number standard deviation for the anomaly detection to be rendered on the graph widget. --- ##### `metric`^Required ```typescript public readonly metric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric metric to alarm on. --- ##### `addAlarmOnAnomaly`^Optional ```typescript public readonly addAlarmOnAnomaly: {[ key: string ]: AnomalyDetectionThreshold}; ``` - *Type:* {[ key: string ]: AnomalyDetectionThreshold} adds alarm on a detected anomaly. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* metric period (if defined) or global default anomaly detection period. --- ### CustomMonitoringProps #### Initializer ```typescript import { CustomMonitoringProps } from 'cdk-monitoring-constructs' const customMonitoringProps: CustomMonitoringProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | metricGroups | CustomMetricGroup[] | define metric groups and metrics inside them (each metric group represents a widget). | | description | string | optional description of the whole section, in markdown. | | descriptionWidgetHeight | number | optional height of the description widget, so the content fits. | | height | number | Height override. | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `metricGroups`^Required ```typescript public readonly metricGroups: CustomMetricGroup[]; ``` - *Type:* CustomMetricGroup[] define metric groups and metrics inside them (each metric group represents a widget). --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string - *Default:* no description optional description of the whole section, in markdown. --- ##### `descriptionWidgetHeight`^Optional ```typescript public readonly descriptionWidgetHeight: number; ``` - *Type:* number - *Default:* minimum height (should fit one or two lines of text) optional height of the description widget, so the content fits. --- ##### `height`^Optional ```typescript public readonly height: number; ``` - *Type:* number - *Default:* default height Height override. --- ### CustomThreshold #### Initializer ```typescript import { CustomThreshold } from 'cdk-monitoring-constructs' const customThreshold: CustomThreshold = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | actionOverride | IAlarmActionStrategy | Allows to override the default alarm action. | | actionsEnabled | boolean | Enables the configured CloudWatch alarm ticketing actions. | | alarmDedupeStringSuffix | string | If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. | | alarmDescriptionOverride | string | A text included in the generated ticket description body, which fully replaces the generated text. | | alarmNameOverride | string | If this is defined, the alarm name is set to this exact value. | | comparisonOperatorOverride | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | Comparison operator used to compare actual value against the threshold. | | customParams | {[ key: string ]: any} | This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | customTags | string[] | This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | datapointsToAlarm | number | Number of breaches required to transition into an ALARM state. | | dedupeStringOverride | string | If this is defined, the alarm dedupe string is set to this exact value. | | documentationLink | string | An optional link included in the generated ticket description body. | | evaluateLowSampleCountPercentile | boolean | Used only for alarms based on percentiles. | | evaluationPeriods | number | Number of periods to consider when checking the number of breaching datapoints. | | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | | minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | sampleCountMetricId | string | This property is required in the following situation:

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | *No description.* | | threshold | number | *No description.* | | additionalDescription | string | *No description.* | | dedupeString | string | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

Hello! This is a custom widget.

" + JSON.stringify(event, null, 2) + "

"); }; ``` --- ##### `handlerParams`^Optional ```typescript public readonly handlerParams: any; ``` - *Type:* any Arguments to pass to the Lambda. These arguments will be available in the Lambda context. --- ##### `height`^Optional ```typescript public readonly height: number; ``` - *Type:* number - *Default:* 6 Height of the widget. --- ##### `title`^Optional ```typescript public readonly title: string; ``` - *Type:* string Title for the graph. --- ##### `updateOnRefresh`^Optional ```typescript public readonly updateOnRefresh: boolean; ``` - *Type:* boolean - *Default:* true Whether the widget should be updated (by calling the Lambda again) on refresh. --- ##### `updateOnResize`^Optional ```typescript public readonly updateOnResize: boolean; ``` - *Type:* boolean - *Default:* true Whether the widget should be updated (by calling the Lambda again) on resize. --- ##### `updateOnTimeRangeChange`^Optional ```typescript public readonly updateOnTimeRangeChange: boolean; ``` - *Type:* boolean - *Default:* true Whether the widget should be updated (by calling the Lambda again) on time range change. --- ##### `width`^Optional ```typescript public readonly width: number; ``` - *Type:* number - *Default:* 6 Width of the widget, in a grid of 24 units wide. --- ### DaysSinceUpdateThreshold #### Initializer ```typescript import { DaysSinceUpdateThreshold } from 'cdk-monitoring-constructs' const daysSinceUpdateThreshold: DaysSinceUpdateThreshold = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | actionOverride | IAlarmActionStrategy | Allows to override the default alarm action. | | actionsEnabled | boolean | Enables the configured CloudWatch alarm ticketing actions. | | alarmDedupeStringSuffix | string | If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. | | alarmDescriptionOverride | string | A text included in the generated ticket description body, which fully replaces the generated text. | | alarmNameOverride | string | If this is defined, the alarm name is set to this exact value. | | comparisonOperatorOverride | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | Comparison operator used to compare actual value against the threshold. | | customParams | {[ key: string ]: any} | This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | customTags | string[] | This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | datapointsToAlarm | number | Number of breaches required to transition into an ALARM state. | | dedupeStringOverride | string | If this is defined, the alarm dedupe string is set to this exact value. | | documentationLink | string | An optional link included in the generated ticket description body. | | evaluateLowSampleCountPercentile | boolean | Used only for alarms based on percentiles. | | evaluationPeriods | number | Number of periods to consider when checking the number of breaching datapoints. | | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | | minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | sampleCountMetricId | string | This property is required in the following situation:

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxDaysSinceUpdate | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minDaysToExpiry | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxDuration | aws-cdk-lib.Duration | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancedEc2Service \| aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedEc2Service

| *No description.* | | addHealthyTaskCountAlarm | {[ key: string ]: HealthyTaskCountThreshold} | *No description.* | | addHealthyTaskPercentAlarm | {[ key: string ]: HealthyTaskPercentThreshold} | *No description.* | | addMinProcessedBytesAlarm | {[ key: string ]: MinProcessedBytesThreshold} | *No description.* | | addUnhealthyTaskCountAlarm | {[ key: string ]: UnhealthyTaskCountThreshold} | *No description.* | | invertLoadBalancerTaskCountMetricsStatistics | boolean | Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`. | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addCpuP100UsageAlarm`^Optional ```typescript public readonly addCpuP100UsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addCpuUsageAlarm`^Optional ```typescript public readonly addCpuUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addEphermalStorageUsageAlarm`^Optional ```typescript public readonly addEphermalStorageUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} Container Insights needs to be enabled for the cluster for this alarm. --- ##### `addMemoryP100UsageAlarm`^Optional ```typescript public readonly addMemoryP100UsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addMemoryUsageAlarm`^Optional ```typescript public readonly addMemoryUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addRunningTaskCountAlarm`^Optional ```typescript public readonly addRunningTaskCountAlarm: {[ key: string ]: RunningTaskCountThreshold}; ``` - *Type:* {[ key: string ]: RunningTaskCountThreshold} Container Insights needs to be enabled for the cluster for this alarm. --- ##### `maxAutoScalingTaskCount`^Optional ```typescript public readonly maxAutoScalingTaskCount: number; ``` - *Type:* number Maximum number of tasks, as specified in your auto scaling config. --- ##### `minAutoScalingTaskCount`^Optional ```typescript public readonly minAutoScalingTaskCount: number; ``` - *Type:* number Minimum number of tasks, as specified in your auto scaling config. --- ##### `ec2Service`^Required ```typescript public readonly ec2Service: NetworkLoadBalancedEc2Service | ApplicationLoadBalancedEc2Service; ``` - *Type:* aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancedEc2Service | aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedEc2Service --- ##### `addHealthyTaskCountAlarm`^Optional ```typescript public readonly addHealthyTaskCountAlarm: {[ key: string ]: HealthyTaskCountThreshold}; ``` - *Type:* {[ key: string ]: HealthyTaskCountThreshold} --- ##### `addHealthyTaskPercentAlarm`^Optional ```typescript public readonly addHealthyTaskPercentAlarm: {[ key: string ]: HealthyTaskPercentThreshold}; ``` - *Type:* {[ key: string ]: HealthyTaskPercentThreshold} --- ##### `addMinProcessedBytesAlarm`^Optional ```typescript public readonly addMinProcessedBytesAlarm: {[ key: string ]: MinProcessedBytesThreshold}; ``` - *Type:* {[ key: string ]: MinProcessedBytesThreshold} --- ##### `addUnhealthyTaskCountAlarm`^Optional ```typescript public readonly addUnhealthyTaskCountAlarm: {[ key: string ]: UnhealthyTaskCountThreshold}; ``` - *Type:* {[ key: string ]: UnhealthyTaskCountThreshold} --- ##### `invertLoadBalancerTaskCountMetricsStatistics`^Optional ```typescript public readonly invertLoadBalancerTaskCountMetricsStatistics: boolean; ``` - *Type:* boolean - *Default:* false Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`. When `invertLoadBalancerTaskCountMetricsStatistics` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored. When `invertLoadBalancerTaskCountMetricsStatistics` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored. `invertLoadBalancerTaskCountMetricsStatistics` is recommended to set to true as per the guidelines at https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics --- ### ElastiCacheAspectType #### Initializer ```typescript import { ElastiCacheAspectType } from 'cdk-monitoring-constructs' const elastiCacheAspectType: ElastiCacheAspectType = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | If the monitoring aspect is enabled for this resource. | | props | ElastiCacheClusterMonitoringOptions | *No description.* | --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean - *Default:* true If the monitoring aspect is enabled for this resource. --- ##### `props`^Optional ```typescript public readonly props: ElastiCacheClusterMonitoringOptions; ``` - *Type:* ElastiCacheClusterMonitoringOptions --- ### ElastiCacheClusterMetricFactoryProps #### Initializer ```typescript import { ElastiCacheClusterMetricFactoryProps } from 'cdk-monitoring-constructs' const elastiCacheClusterMetricFactoryProps: ElastiCacheClusterMetricFactoryProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | clusterId | string | Cluster to monitor. | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `clusterId`^Optional ```typescript public readonly clusterId: string; ``` - *Type:* string - *Default:* monitor all clusters Cluster to monitor. --- ### ElastiCacheClusterMonitoringOptions #### Initializer ```typescript import { ElastiCacheClusterMonitoringOptions } from 'cdk-monitoring-constructs' const elastiCacheClusterMonitoringOptions: ElastiCacheClusterMonitoringOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | clusterType | ElastiCacheClusterType | Cluster type (needed, since each type has their own specific metrics). | | addCpuUsageAlarm | {[ key: string ]: UsageThreshold} | Add CPU usage alarm (useful for all clusterTypes including Redis). | | addMaxEvictedItemsCountAlarm | {[ key: string ]: MaxItemsCountThreshold} | Add alarm on number of evicted items. | | addMaxItemsCountAlarm | {[ key: string ]: MaxItemsCountThreshold} | Add alarm on total number of items. | | addMaxUsedSwapMemoryAlarm | {[ key: string ]: MaxUsedSwapMemoryThreshold} | Add alarm on amount of used swap memory. | | addMinFreeableMemoryAlarm | {[ key: string ]: MinFreeableMemoryThreshold} | Add alarm on amount of freeable memory. | | addRedisEngineCpuUsageAlarm | {[ key: string ]: UsageThreshold} | Add Redis engine CPU usage alarm. | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `clusterType`^Required ```typescript public readonly clusterType: ElastiCacheClusterType; ``` - *Type:* ElastiCacheClusterType Cluster type (needed, since each type has their own specific metrics). --- ##### `addCpuUsageAlarm`^Optional ```typescript public readonly addCpuUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} Add CPU usage alarm (useful for all clusterTypes including Redis). --- ##### `addMaxEvictedItemsCountAlarm`^Optional ```typescript public readonly addMaxEvictedItemsCountAlarm: {[ key: string ]: MaxItemsCountThreshold}; ``` - *Type:* {[ key: string ]: MaxItemsCountThreshold} Add alarm on number of evicted items. --- ##### `addMaxItemsCountAlarm`^Optional ```typescript public readonly addMaxItemsCountAlarm: {[ key: string ]: MaxItemsCountThreshold}; ``` - *Type:* {[ key: string ]: MaxItemsCountThreshold} Add alarm on total number of items. --- ##### `addMaxUsedSwapMemoryAlarm`^Optional ```typescript public readonly addMaxUsedSwapMemoryAlarm: {[ key: string ]: MaxUsedSwapMemoryThreshold}; ``` - *Type:* {[ key: string ]: MaxUsedSwapMemoryThreshold} Add alarm on amount of used swap memory. --- ##### `addMinFreeableMemoryAlarm`^Optional ```typescript public readonly addMinFreeableMemoryAlarm: {[ key: string ]: MinFreeableMemoryThreshold}; ``` - *Type:* {[ key: string ]: MinFreeableMemoryThreshold} Add alarm on amount of freeable memory. --- ##### `addRedisEngineCpuUsageAlarm`^Optional ```typescript public readonly addRedisEngineCpuUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} Add Redis engine CPU usage alarm. It is recommended to monitor CPU utilization with `addCpuUsageAlarm` as well for hosts with two vCPUs or less. --- ### ElastiCacheClusterMonitoringProps #### Initializer ```typescript import { ElastiCacheClusterMonitoringProps } from 'cdk-monitoring-constructs' const elastiCacheClusterMonitoringProps: ElastiCacheClusterMonitoringProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | clusterId | string | Cluster to monitor. | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | clusterType | ElastiCacheClusterType | Cluster type (needed, since each type has their own specific metrics). | | addCpuUsageAlarm | {[ key: string ]: UsageThreshold} | Add CPU usage alarm (useful for all clusterTypes including Redis). | | addMaxEvictedItemsCountAlarm | {[ key: string ]: MaxItemsCountThreshold} | Add alarm on number of evicted items. | | addMaxItemsCountAlarm | {[ key: string ]: MaxItemsCountThreshold} | Add alarm on total number of items. | | addMaxUsedSwapMemoryAlarm | {[ key: string ]: MaxUsedSwapMemoryThreshold} | Add alarm on amount of used swap memory. | | addMinFreeableMemoryAlarm | {[ key: string ]: MinFreeableMemoryThreshold} | Add alarm on amount of freeable memory. | | addRedisEngineCpuUsageAlarm | {[ key: string ]: UsageThreshold} | Add Redis engine CPU usage alarm. | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `clusterId`^Optional ```typescript public readonly clusterId: string; ``` - *Type:* string - *Default:* monitor all clusters Cluster to monitor. --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `clusterType`^Required ```typescript public readonly clusterType: ElastiCacheClusterType; ``` - *Type:* ElastiCacheClusterType Cluster type (needed, since each type has their own specific metrics). --- ##### `addCpuUsageAlarm`^Optional ```typescript public readonly addCpuUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} Add CPU usage alarm (useful for all clusterTypes including Redis). --- ##### `addMaxEvictedItemsCountAlarm`^Optional ```typescript public readonly addMaxEvictedItemsCountAlarm: {[ key: string ]: MaxItemsCountThreshold}; ``` - *Type:* {[ key: string ]: MaxItemsCountThreshold} Add alarm on number of evicted items. --- ##### `addMaxItemsCountAlarm`^Optional ```typescript public readonly addMaxItemsCountAlarm: {[ key: string ]: MaxItemsCountThreshold}; ``` - *Type:* {[ key: string ]: MaxItemsCountThreshold} Add alarm on total number of items. --- ##### `addMaxUsedSwapMemoryAlarm`^Optional ```typescript public readonly addMaxUsedSwapMemoryAlarm: {[ key: string ]: MaxUsedSwapMemoryThreshold}; ``` - *Type:* {[ key: string ]: MaxUsedSwapMemoryThreshold} Add alarm on amount of used swap memory. --- ##### `addMinFreeableMemoryAlarm`^Optional ```typescript public readonly addMinFreeableMemoryAlarm: {[ key: string ]: MinFreeableMemoryThreshold}; ``` - *Type:* {[ key: string ]: MinFreeableMemoryThreshold} Add alarm on amount of freeable memory. --- ##### `addRedisEngineCpuUsageAlarm`^Optional ```typescript public readonly addRedisEngineCpuUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} Add Redis engine CPU usage alarm. It is recommended to monitor CPU utilization with `addCpuUsageAlarm` as well for hosts with two vCPUs or less. --- ### ElastiCacheServerlessMetricFactoryProps #### Initializer ```typescript import { ElastiCacheServerlessMetricFactoryProps } from 'cdk-monitoring-constructs' const elastiCacheServerlessMetricFactoryProps: ElastiCacheServerlessMetricFactoryProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | clusterId | string | Cluster to monitor. | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `clusterId`^Optional ```typescript public readonly clusterId: string; ``` - *Type:* string - *Default:* monitor all clusters Cluster to monitor. --- ### ElastiCacheServerlessMonitoringOptions Configuration options for monitoring ElastiCache Serverless clusters. Extends BaseMonitoringProps to include alarm configurations specific to ElastiCache Serverless metrics such as latency, throttling, cache hit rates, and item counts. #### Initializer ```typescript import { ElastiCacheServerlessMonitoringOptions } from 'cdk-monitoring-constructs' const elastiCacheServerlessMonitoringOptions: ElastiCacheServerlessMonitoringOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | addAverageSuccessfulReadRequestLatencyAlarm | {[ key: string ]: LatencyThreshold} | Add alarm when the average latency for successful read requests exceeds a threshold. | | addAverageSuccessfulWriteRequestLatencyAlarm | {[ key: string ]: LatencyThreshold} | Add alarm when the average latency for successful write requests exceeds a threshold. | | addHitRateAlarm | {[ key: string ]: MinHitRateThreshold} | Add alarm when the cache hit rate falls below a minimum threshold. | | addThrottleRateAlarm | {[ key: string ]: MaxThrottleRateThreshold} | Add alarm when the throttle rate (percentage of throttled commands) exceeds a threshold. | | addTM99SuccessfulReadRequestLatencyAlarm | {[ key: string ]: LatencyThreshold} | Add alarm when the 99th percentile (TM99) latency for successful read requests exceeds a threshold. | | addTM99SuccessfulWriteRequestLatencyAlarm | {[ key: string ]: LatencyThreshold} | Add alarm when the 99th percentile (TM99) latency for successful write requests exceeds a threshold. | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addAverageSuccessfulReadRequestLatencyAlarm`^Optional ```typescript public readonly addAverageSuccessfulReadRequestLatencyAlarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} - *Default:* no alarm Add alarm when the average latency for successful read requests exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the latency threshold. --- ##### `addAverageSuccessfulWriteRequestLatencyAlarm`^Optional ```typescript public readonly addAverageSuccessfulWriteRequestLatencyAlarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} - *Default:* no alarm Add alarm when the average latency for successful write requests exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the latency threshold. --- ##### `addHitRateAlarm`^Optional ```typescript public readonly addHitRateAlarm: {[ key: string ]: MinHitRateThreshold}; ``` - *Type:* {[ key: string ]: MinHitRateThreshold} - *Default:* no alarm Add alarm when the cache hit rate falls below a minimum threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the minimum hit rate threshold. --- ##### `addThrottleRateAlarm`^Optional ```typescript public readonly addThrottleRateAlarm: {[ key: string ]: MaxThrottleRateThreshold}; ``` - *Type:* {[ key: string ]: MaxThrottleRateThreshold} - *Default:* no alarm Add alarm when the throttle rate (percentage of throttled commands) exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the usage threshold. --- ##### `addTM99SuccessfulReadRequestLatencyAlarm`^Optional ```typescript public readonly addTM99SuccessfulReadRequestLatencyAlarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} - *Default:* no alarm Add alarm when the 99th percentile (TM99) latency for successful read requests exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the latency threshold. --- ##### `addTM99SuccessfulWriteRequestLatencyAlarm`^Optional ```typescript public readonly addTM99SuccessfulWriteRequestLatencyAlarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} - *Default:* no alarm Add alarm when the 99th percentile (TM99) latency for successful write requests exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the latency threshold. --- ### ElastiCacheServerlessMonitoringProps #### Initializer ```typescript import { ElastiCacheServerlessMonitoringProps } from 'cdk-monitoring-constructs' const elastiCacheServerlessMonitoringProps: ElastiCacheServerlessMonitoringProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | clusterId | string | Cluster to monitor. | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | addAverageSuccessfulReadRequestLatencyAlarm | {[ key: string ]: LatencyThreshold} | Add alarm when the average latency for successful read requests exceeds a threshold. | | addAverageSuccessfulWriteRequestLatencyAlarm | {[ key: string ]: LatencyThreshold} | Add alarm when the average latency for successful write requests exceeds a threshold. | | addHitRateAlarm | {[ key: string ]: MinHitRateThreshold} | Add alarm when the cache hit rate falls below a minimum threshold. | | addThrottleRateAlarm | {[ key: string ]: MaxThrottleRateThreshold} | Add alarm when the throttle rate (percentage of throttled commands) exceeds a threshold. | | addTM99SuccessfulReadRequestLatencyAlarm | {[ key: string ]: LatencyThreshold} | Add alarm when the 99th percentile (TM99) latency for successful read requests exceeds a threshold. | | addTM99SuccessfulWriteRequestLatencyAlarm | {[ key: string ]: LatencyThreshold} | Add alarm when the 99th percentile (TM99) latency for successful write requests exceeds a threshold. | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `clusterId`^Optional ```typescript public readonly clusterId: string; ``` - *Type:* string - *Default:* monitor all clusters Cluster to monitor. --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addAverageSuccessfulReadRequestLatencyAlarm`^Optional ```typescript public readonly addAverageSuccessfulReadRequestLatencyAlarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} - *Default:* no alarm Add alarm when the average latency for successful read requests exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the latency threshold. --- ##### `addAverageSuccessfulWriteRequestLatencyAlarm`^Optional ```typescript public readonly addAverageSuccessfulWriteRequestLatencyAlarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} - *Default:* no alarm Add alarm when the average latency for successful write requests exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the latency threshold. --- ##### `addHitRateAlarm`^Optional ```typescript public readonly addHitRateAlarm: {[ key: string ]: MinHitRateThreshold}; ``` - *Type:* {[ key: string ]: MinHitRateThreshold} - *Default:* no alarm Add alarm when the cache hit rate falls below a minimum threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the minimum hit rate threshold. --- ##### `addThrottleRateAlarm`^Optional ```typescript public readonly addThrottleRateAlarm: {[ key: string ]: MaxThrottleRateThreshold}; ``` - *Type:* {[ key: string ]: MaxThrottleRateThreshold} - *Default:* no alarm Add alarm when the throttle rate (percentage of throttled commands) exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the usage threshold. --- ##### `addTM99SuccessfulReadRequestLatencyAlarm`^Optional ```typescript public readonly addTM99SuccessfulReadRequestLatencyAlarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} - *Default:* no alarm Add alarm when the 99th percentile (TM99) latency for successful read requests exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the latency threshold. --- ##### `addTM99SuccessfulWriteRequestLatencyAlarm`^Optional ```typescript public readonly addTM99SuccessfulWriteRequestLatencyAlarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} - *Default:* no alarm Add alarm when the 99th percentile (TM99) latency for successful write requests exceeds a threshold. The key is a disambiguator (e.g., "Warning", "Critical") and the value defines the latency threshold. --- ### ErrorCountThreshold #### Initializer ```typescript import { ErrorCountThreshold } from 'cdk-monitoring-constructs' const errorCountThreshold: ErrorCountThreshold = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | actionOverride | IAlarmActionStrategy | Allows to override the default alarm action. | | actionsEnabled | boolean | Enables the configured CloudWatch alarm ticketing actions. | | alarmDedupeStringSuffix | string | If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. | | alarmDescriptionOverride | string | A text included in the generated ticket description body, which fully replaces the generated text. | | alarmNameOverride | string | If this is defined, the alarm name is set to this exact value. | | comparisonOperatorOverride | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | Comparison operator used to compare actual value against the threshold. | | customParams | {[ key: string ]: any} | This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | customTags | string[] | This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | datapointsToAlarm | number | Number of breaches required to transition into an ALARM state. | | dedupeStringOverride | string | If this is defined, the alarm dedupe string is set to this exact value. | | documentationLink | string | An optional link included in the generated ticket description body. | | evaluateLowSampleCountPercentile | boolean | Used only for alarms based on percentiles. | | evaluationPeriods | number | Number of periods to consider when checking the number of breaching datapoints. | | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | | minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | sampleCountMetricId | string | This property is required in the following situation:

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxErrorCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxErrorRate | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancedFargateService \| aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedFargateService

| *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addCpuP100UsageAlarm`^Optional ```typescript public readonly addCpuP100UsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addCpuUsageAlarm`^Optional ```typescript public readonly addCpuUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addEphermalStorageUsageAlarm`^Optional ```typescript public readonly addEphermalStorageUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} Container Insights needs to be enabled for the cluster for this alarm. --- ##### `addMemoryP100UsageAlarm`^Optional ```typescript public readonly addMemoryP100UsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addMemoryUsageAlarm`^Optional ```typescript public readonly addMemoryUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addRunningTaskCountAlarm`^Optional ```typescript public readonly addRunningTaskCountAlarm: {[ key: string ]: RunningTaskCountThreshold}; ``` - *Type:* {[ key: string ]: RunningTaskCountThreshold} Container Insights needs to be enabled for the cluster for this alarm. --- ##### `maxAutoScalingTaskCount`^Optional ```typescript public readonly maxAutoScalingTaskCount: number; ``` - *Type:* number Maximum number of tasks, as specified in your auto scaling config. --- ##### `minAutoScalingTaskCount`^Optional ```typescript public readonly minAutoScalingTaskCount: number; ``` - *Type:* number Minimum number of tasks, as specified in your auto scaling config. --- ##### `addHealthyTaskCountAlarm`^Optional ```typescript public readonly addHealthyTaskCountAlarm: {[ key: string ]: HealthyTaskCountThreshold}; ``` - *Type:* {[ key: string ]: HealthyTaskCountThreshold} --- ##### `addHealthyTaskPercentAlarm`^Optional ```typescript public readonly addHealthyTaskPercentAlarm: {[ key: string ]: HealthyTaskPercentThreshold}; ``` - *Type:* {[ key: string ]: HealthyTaskPercentThreshold} --- ##### `addMinProcessedBytesAlarm`^Optional ```typescript public readonly addMinProcessedBytesAlarm: {[ key: string ]: MinProcessedBytesThreshold}; ``` - *Type:* {[ key: string ]: MinProcessedBytesThreshold} --- ##### `addUnhealthyTaskCountAlarm`^Optional ```typescript public readonly addUnhealthyTaskCountAlarm: {[ key: string ]: UnhealthyTaskCountThreshold}; ``` - *Type:* {[ key: string ]: UnhealthyTaskCountThreshold} --- ##### `invertLoadBalancerTaskCountMetricsStatistics`^Optional ```typescript public readonly invertLoadBalancerTaskCountMetricsStatistics: boolean; ``` - *Type:* boolean - *Default:* false Invert the statistics of `HealthyHostCount` and `UnHealthyHostCount`. When `invertLoadBalancerTaskCountMetricsStatistics` is set to false, the minimum of `HealthyHostCount` and the maximum of `UnHealthyHostCount` are monitored. When `invertLoadBalancerTaskCountMetricsStatistics` is set to true, the maximum of `HealthyHostCount` and the minimum of `UnHealthyHostCount` are monitored. `invertLoadBalancerTaskCountMetricsStatistics` is recommended to set to true as per the guidelines at https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-cloudwatch-metrics.html#metric-statistics --- ##### `fargateService`^Required ```typescript public readonly fargateService: NetworkLoadBalancedFargateService | ApplicationLoadBalancedFargateService; ``` - *Type:* aws-cdk-lib.aws_ecs_patterns.NetworkLoadBalancedFargateService | aws-cdk-lib.aws_ecs_patterns.ApplicationLoadBalancedFargateService --- ### FirehoseStreamLimitThreshold #### Initializer ```typescript import { FirehoseStreamLimitThreshold } from 'cdk-monitoring-constructs' const firehoseStreamLimitThreshold: FirehoseStreamLimitThreshold = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | actionOverride | IAlarmActionStrategy | Allows to override the default alarm action. | | actionsEnabled | boolean | Enables the configured CloudWatch alarm ticketing actions. | | alarmDedupeStringSuffix | string | If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. | | alarmDescriptionOverride | string | A text included in the generated ticket description body, which fully replaces the generated text. | | alarmNameOverride | string | If this is defined, the alarm name is set to this exact value. | | comparisonOperatorOverride | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | Comparison operator used to compare actual value against the threshold. | | customParams | {[ key: string ]: any} | This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | customTags | string[] | This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | datapointsToAlarm | number | Number of breaches required to transition into an ALARM state. | | dedupeStringOverride | string | If this is defined, the alarm dedupe string is set to this exact value. | | documentationLink | string | An optional link included in the generated ticket description body. | | evaluateLowSampleCountPercentile | boolean | Used only for alarms based on percentiles. | | evaluationPeriods | number | Number of periods to consider when checking the number of breaching datapoints. | | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | | minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | sampleCountMetricId | string | This property is required in the following situation:

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | safetyThresholdLimit | number | Threshold value between [0.0, 1.0) for when the alarm should be triggered. | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxFullRestartCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minHealthyTasks | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minHealthyTaskPercent | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxConnectionCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxMessagesPublishedCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxServerlessDatabaseCapacity | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxTps | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxLatency | aws-cdk-lib.Duration | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxLatencyPercentageOfTimeout | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxLogCount | number | Threshold for the number of logs to alarm on. | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minConnectionCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minMessagesPublishedCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minTps | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxAgeInMillis | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxBackPressuredTimeMsPerSecond | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxDowntimeInMillis | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxIncomingMessagesCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxItemsCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxAgeInSeconds | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxMessageCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxOffsetLag | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxSecretCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxThrottleRatePercent | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxTimeToDrain | aws-cdk-lib.Duration | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxUsedSwapMemoryInBytes | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minSuccessRate | number | Minimum acceptable SubscribeToShard.Success average (0.0–1.0). | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minFreeableMemoryInBytes | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minHitRatePercent | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minIncomingMessagesCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minMessageCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minProcessedBytes | number | Threshold for the least number of bytes processed. | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minRunningTasks | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minSecretCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxNetworkInBytes | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxNetworkOutBytes | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxNotificationsFailedCount | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxFailures | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxBlockedWrites | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

aws-cdk-lib.aws_opensearchservice.CfnDomain \| aws-cdk-lib.aws_opensearchservice.IDomain \| aws-cdk-lib.aws_elasticsearch.CfnDomain \| aws-cdk-lib.aws_elasticsearch.IDomain

| *No description.* | | fillTpsWithZeroes | boolean | *No description.* | | rateComputationMethod | RateComputationMethod | *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `domain`^Required ```typescript public readonly domain: CfnDomain | IDomain | CfnDomain | IDomain; ``` - *Type:* aws-cdk-lib.aws_opensearchservice.CfnDomain | aws-cdk-lib.aws_opensearchservice.IDomain | aws-cdk-lib.aws_elasticsearch.CfnDomain | aws-cdk-lib.aws_elasticsearch.IDomain --- ##### `fillTpsWithZeroes`^Optional ```typescript public readonly fillTpsWithZeroes: boolean; ``` - *Type:* boolean - *Default:* true --- ##### `rateComputationMethod`^Optional ```typescript public readonly rateComputationMethod: RateComputationMethod; ``` - *Type:* RateComputationMethod - *Default:* average --- ### OpenSearchClusterMonitoringOptions #### Initializer ```typescript import { OpenSearchClusterMonitoringOptions } from 'cdk-monitoring-constructs' const openSearchClusterMonitoringOptions: OpenSearchClusterMonitoringOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | addClusterAutomatedSnapshotFailureAlarm | {[ key: string ]: OpenSearchClusterAutomatedSnapshotFailureThreshold} | *No description.* | | addClusterIndexWritesBlockedAlarm | {[ key: string ]: OpenSearchClusterIndexWritesBlockedThreshold} | *No description.* | | addClusterNodeCountAlarm | {[ key: string ]: OpenSearchClusterNodesThreshold} | *No description.* | | addClusterStatusAlarm | {[ key: string ]: OpenSearchClusterStatusCustomization} | *No description.* | | addCpuSpaceUsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addDiskSpaceUsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addIndexingLatencyP50Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addIndexingLatencyP90Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addIndexingLatencyP99Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addJvmMemoryPressureAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addKmsKeyErrorAlarm | {[ key: string ]: OpenSearchKmsKeyErrorThreshold} | *No description.* | | addKmsKeyInaccessibleAlarm | {[ key: string ]: OpenSearchKmsKeyInaccessibleThreshold} | *No description.* | | addMasterCpuSpaceUsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addMasterJvmMemoryPressureAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addSearchLatencyP50Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addSearchLatencyP90Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addSearchLatencyP99Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addClusterAutomatedSnapshotFailureAlarm`^Optional ```typescript public readonly addClusterAutomatedSnapshotFailureAlarm: {[ key: string ]: OpenSearchClusterAutomatedSnapshotFailureThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchClusterAutomatedSnapshotFailureThreshold} --- ##### `addClusterIndexWritesBlockedAlarm`^Optional ```typescript public readonly addClusterIndexWritesBlockedAlarm: {[ key: string ]: OpenSearchClusterIndexWritesBlockedThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchClusterIndexWritesBlockedThreshold} --- ##### `addClusterNodeCountAlarm`^Optional ```typescript public readonly addClusterNodeCountAlarm: {[ key: string ]: OpenSearchClusterNodesThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchClusterNodesThreshold} --- ##### `addClusterStatusAlarm`^Optional ```typescript public readonly addClusterStatusAlarm: {[ key: string ]: OpenSearchClusterStatusCustomization}; ``` - *Type:* {[ key: string ]: OpenSearchClusterStatusCustomization} --- ##### `addCpuSpaceUsageAlarm`^Optional ```typescript public readonly addCpuSpaceUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addDiskSpaceUsageAlarm`^Optional ```typescript public readonly addDiskSpaceUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addIndexingLatencyP50Alarm`^Optional ```typescript public readonly addIndexingLatencyP50Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addIndexingLatencyP90Alarm`^Optional ```typescript public readonly addIndexingLatencyP90Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addIndexingLatencyP99Alarm`^Optional ```typescript public readonly addIndexingLatencyP99Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addJvmMemoryPressureAlarm`^Optional ```typescript public readonly addJvmMemoryPressureAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addKmsKeyErrorAlarm`^Optional ```typescript public readonly addKmsKeyErrorAlarm: {[ key: string ]: OpenSearchKmsKeyErrorThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchKmsKeyErrorThreshold} --- ##### `addKmsKeyInaccessibleAlarm`^Optional ```typescript public readonly addKmsKeyInaccessibleAlarm: {[ key: string ]: OpenSearchKmsKeyInaccessibleThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchKmsKeyInaccessibleThreshold} --- ##### `addMasterCpuSpaceUsageAlarm`^Optional ```typescript public readonly addMasterCpuSpaceUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addMasterJvmMemoryPressureAlarm`^Optional ```typescript public readonly addMasterJvmMemoryPressureAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addSearchLatencyP50Alarm`^Optional ```typescript public readonly addSearchLatencyP50Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addSearchLatencyP90Alarm`^Optional ```typescript public readonly addSearchLatencyP90Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addSearchLatencyP99Alarm`^Optional ```typescript public readonly addSearchLatencyP99Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ### OpenSearchClusterMonitoringProps #### Initializer ```typescript import { OpenSearchClusterMonitoringProps } from 'cdk-monitoring-constructs' const openSearchClusterMonitoringProps: OpenSearchClusterMonitoringProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | domain |

aws-cdk-lib.aws_opensearchservice.CfnDomain \| aws-cdk-lib.aws_opensearchservice.IDomain \| aws-cdk-lib.aws_elasticsearch.CfnDomain \| aws-cdk-lib.aws_elasticsearch.IDomain

| *No description.* | | fillTpsWithZeroes | boolean | *No description.* | | rateComputationMethod | RateComputationMethod | *No description.* | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | addClusterAutomatedSnapshotFailureAlarm | {[ key: string ]: OpenSearchClusterAutomatedSnapshotFailureThreshold} | *No description.* | | addClusterIndexWritesBlockedAlarm | {[ key: string ]: OpenSearchClusterIndexWritesBlockedThreshold} | *No description.* | | addClusterNodeCountAlarm | {[ key: string ]: OpenSearchClusterNodesThreshold} | *No description.* | | addClusterStatusAlarm | {[ key: string ]: OpenSearchClusterStatusCustomization} | *No description.* | | addCpuSpaceUsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addDiskSpaceUsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addIndexingLatencyP50Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addIndexingLatencyP90Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addIndexingLatencyP99Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addJvmMemoryPressureAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addKmsKeyErrorAlarm | {[ key: string ]: OpenSearchKmsKeyErrorThreshold} | *No description.* | | addKmsKeyInaccessibleAlarm | {[ key: string ]: OpenSearchKmsKeyInaccessibleThreshold} | *No description.* | | addMasterCpuSpaceUsageAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addMasterJvmMemoryPressureAlarm | {[ key: string ]: UsageThreshold} | *No description.* | | addSearchLatencyP50Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addSearchLatencyP90Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | | addSearchLatencyP99Alarm | {[ key: string ]: LatencyThreshold} | *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `domain`^Required ```typescript public readonly domain: CfnDomain | IDomain | CfnDomain | IDomain; ``` - *Type:* aws-cdk-lib.aws_opensearchservice.CfnDomain | aws-cdk-lib.aws_opensearchservice.IDomain | aws-cdk-lib.aws_elasticsearch.CfnDomain | aws-cdk-lib.aws_elasticsearch.IDomain --- ##### `fillTpsWithZeroes`^Optional ```typescript public readonly fillTpsWithZeroes: boolean; ``` - *Type:* boolean - *Default:* true --- ##### `rateComputationMethod`^Optional ```typescript public readonly rateComputationMethod: RateComputationMethod; ``` - *Type:* RateComputationMethod - *Default:* average --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addClusterAutomatedSnapshotFailureAlarm`^Optional ```typescript public readonly addClusterAutomatedSnapshotFailureAlarm: {[ key: string ]: OpenSearchClusterAutomatedSnapshotFailureThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchClusterAutomatedSnapshotFailureThreshold} --- ##### `addClusterIndexWritesBlockedAlarm`^Optional ```typescript public readonly addClusterIndexWritesBlockedAlarm: {[ key: string ]: OpenSearchClusterIndexWritesBlockedThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchClusterIndexWritesBlockedThreshold} --- ##### `addClusterNodeCountAlarm`^Optional ```typescript public readonly addClusterNodeCountAlarm: {[ key: string ]: OpenSearchClusterNodesThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchClusterNodesThreshold} --- ##### `addClusterStatusAlarm`^Optional ```typescript public readonly addClusterStatusAlarm: {[ key: string ]: OpenSearchClusterStatusCustomization}; ``` - *Type:* {[ key: string ]: OpenSearchClusterStatusCustomization} --- ##### `addCpuSpaceUsageAlarm`^Optional ```typescript public readonly addCpuSpaceUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addDiskSpaceUsageAlarm`^Optional ```typescript public readonly addDiskSpaceUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addIndexingLatencyP50Alarm`^Optional ```typescript public readonly addIndexingLatencyP50Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addIndexingLatencyP90Alarm`^Optional ```typescript public readonly addIndexingLatencyP90Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addIndexingLatencyP99Alarm`^Optional ```typescript public readonly addIndexingLatencyP99Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addJvmMemoryPressureAlarm`^Optional ```typescript public readonly addJvmMemoryPressureAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addKmsKeyErrorAlarm`^Optional ```typescript public readonly addKmsKeyErrorAlarm: {[ key: string ]: OpenSearchKmsKeyErrorThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchKmsKeyErrorThreshold} --- ##### `addKmsKeyInaccessibleAlarm`^Optional ```typescript public readonly addKmsKeyInaccessibleAlarm: {[ key: string ]: OpenSearchKmsKeyInaccessibleThreshold}; ``` - *Type:* {[ key: string ]: OpenSearchKmsKeyInaccessibleThreshold} --- ##### `addMasterCpuSpaceUsageAlarm`^Optional ```typescript public readonly addMasterCpuSpaceUsageAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addMasterJvmMemoryPressureAlarm`^Optional ```typescript public readonly addMasterJvmMemoryPressureAlarm: {[ key: string ]: UsageThreshold}; ``` - *Type:* {[ key: string ]: UsageThreshold} --- ##### `addSearchLatencyP50Alarm`^Optional ```typescript public readonly addSearchLatencyP50Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addSearchLatencyP90Alarm`^Optional ```typescript public readonly addSearchLatencyP90Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ##### `addSearchLatencyP99Alarm`^Optional ```typescript public readonly addSearchLatencyP99Alarm: {[ key: string ]: LatencyThreshold}; ``` - *Type:* {[ key: string ]: LatencyThreshold} --- ### OpenSearchClusterNodesThreshold #### Initializer ```typescript import { OpenSearchClusterNodesThreshold } from 'cdk-monitoring-constructs' const openSearchClusterNodesThreshold: OpenSearchClusterNodesThreshold = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | actionOverride | IAlarmActionStrategy | Allows to override the default alarm action. | | actionsEnabled | boolean | Enables the configured CloudWatch alarm ticketing actions. | | alarmDedupeStringSuffix | string | If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. | | alarmDescriptionOverride | string | A text included in the generated ticket description body, which fully replaces the generated text. | | alarmNameOverride | string | If this is defined, the alarm name is set to this exact value. | | comparisonOperatorOverride | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | Comparison operator used to compare actual value against the threshold. | | customParams | {[ key: string ]: any} | This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | customTags | string[] | This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. | | datapointsToAlarm | number | Number of breaches required to transition into an ALARM state. | | dedupeStringOverride | string | If this is defined, the alarm dedupe string is set to this exact value. | | documentationLink | string | An optional link included in the generated ticket description body. | | evaluateLowSampleCountPercentile | boolean | Used only for alarms based on percentiles. | | evaluationPeriods | number | Number of periods to consider when checking the number of breaching datapoints. | | fillAlarmRange | boolean | Indicates whether the alarming range of values should be highlighted in the widget. | | metricAdjuster | IMetricAdjuster | If specified, adjusts the metric before creating an alarm from it. | | minMetricSamplesToAlarm | number | Specifies how many samples (N) of the metric is needed to trigger the alarm. | | minSampleCountToEvaluateDatapoint | number | Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. | | overrideAnnotationColor | string | If specified, it modifies the final alarm annotation color. | | overrideAnnotationLabel | string | If specified, it modifies the final alarm annotation label. | | overrideAnnotationVisibility | boolean | If specified, it modifies the final alarm annotation visibility. | | period | aws-cdk-lib.Duration | Period override for the metric to alarm on. | | runbookLink | string | An optional link included in the generated ticket description body. | | sampleCountMetricId | string | This property is required in the following situation:

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | minNodes | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | status | OpenSearchClusterStatus \| ElasticsearchClusterStatus | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxErrors | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxAccessAttempts | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxRecordsFailedThreshold | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxRecordsThrottledThreshold | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxRunningTasks | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxRunningTaskRate | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxThrottledEventsThreshold | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxUnhealthyTasks | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxUsageCount | number | *No description.* | --- ##### ~~`actionOverride`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### ~~`actionsEnabled`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### ~~`alarmDedupeStringSuffix`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### ~~`alarmDescriptionOverride`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### ~~`alarmNameOverride`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### ~~`comparisonOperatorOverride`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### ~~`customParams`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### ~~`customTags`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### ~~`datapointsToAlarm`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### ~~`dedupeStringOverride`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### ~~`documentationLink`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### ~~`evaluateLowSampleCountPercentile`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### ~~`evaluationPeriods`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### ~~`fillAlarmRange`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### ~~`metricAdjuster`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

This composite alarm will be returned as a result and uses the specified alarm actions. --- ##### ~~`minSampleCountToEvaluateDatapoint`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly minSampleCountToEvaluateDatapoint: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be used Specifies how many samples (N) of the metric is needed in a datapoint to be evaluated for alarming. If this property is specified, your metric will be subject to MathExpression that will add an IF condition to your metric to make sure that each datapoint is evaluated only if it has sufficient number of samples. If the number of samples is not sufficient, the datapoint will be treated as missing data and will be evaluated according to the treatMissingData parameter. If specified, deprecated minMetricSamplesToAlarm has no effect. --- ##### ~~`overrideAnnotationColor`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly overrideAnnotationColor: string; ``` - *Type:* string - *Default:* no override (default color) If specified, it modifies the final alarm annotation color. --- ##### ~~`overrideAnnotationLabel`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly overrideAnnotationLabel: string; ``` - *Type:* string - *Default:* no override (default label) If specified, it modifies the final alarm annotation label. --- ##### ~~`overrideAnnotationVisibility`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly overrideAnnotationVisibility: boolean; ``` - *Type:* boolean - *Default:* no override (default visibility) If specified, it modifies the final alarm annotation visibility. --- ##### ~~`period`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* the default specified in MetricFactory Period override for the metric to alarm on. --- ##### ~~`runbookLink`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly runbookLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### ~~`sampleCountMetricId`~~^Optional - *Deprecated:* Use MaxUsageCountThreshold instead. ```typescript public readonly sampleCountMetricId: string; ``` - *Type:* string This property is required in the following situation:

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. | | treatMissingDataOverride | aws-cdk-lib.aws_cloudwatch.TreatMissingData | Behaviour in case the metric data is missing. | | maxUsagePercent | number | *No description.* | --- ##### `actionOverride`^Optional ```typescript public readonly actionOverride: IAlarmActionStrategy; ``` - *Type:* IAlarmActionStrategy - *Default:* undefined (default action will be used, if any) Allows to override the default alarm action. --- ##### `actionsEnabled`^Optional ```typescript public readonly actionsEnabled: boolean; ``` - *Type:* boolean - *Default:* the same as monitoring facade default Enables the configured CloudWatch alarm ticketing actions. --- ##### `alarmDedupeStringSuffix`^Optional ```typescript public readonly alarmDedupeStringSuffix: string; ``` - *Type:* string - *Default:* undefined (no suffix) If this is defined, the default resource-specific alarm dedupe string will be set and this will be added as a suffix. This allows you to specify the same dedupe string for a family of alarms. Cannot be defined at the same time as dedupeStringOverride. --- ##### `alarmDescriptionOverride`^Optional ```typescript public readonly alarmDescriptionOverride: string; ``` - *Type:* string - *Default:* default auto-generated content only A text included in the generated ticket description body, which fully replaces the generated text. --- ##### `alarmNameOverride`^Optional ```typescript public readonly alarmNameOverride: string; ``` - *Type:* string If this is defined, the alarm name is set to this exact value. Please be aware that you need to specify prefix for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `comparisonOperatorOverride`^Optional ```typescript public readonly comparisonOperatorOverride: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* alarm-specific default Comparison operator used to compare actual value against the threshold. --- ##### `customParams`^Optional ```typescript public readonly customParams: {[ key: string ]: any}; ``` - *Type:* {[ key: string ]: any} - *Default:* no parameters This allows user to attach custom parameters to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `customTags`^Optional ```typescript public readonly customTags: string[]; ``` - *Type:* string[] - *Default:* no tags This allows user to attach custom values to this alarm, which can later be accessed from the "useCreatedAlarms" method. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of breaches required to transition into an ALARM state. --- ##### `dedupeStringOverride`^Optional ```typescript public readonly dedupeStringOverride: string; ``` - *Type:* string - *Default:* undefined (no override) If this is defined, the alarm dedupe string is set to this exact value. Please be aware that you need to handle deduping for different stages (Beta, Prod...) and regions (EU, NA...) manually. --- ##### `documentationLink`^Optional ```typescript public readonly documentationLink: string; ``` - *Type:* string - *Default:* no additional link will be added An optional link included in the generated ticket description body. --- ##### `evaluateLowSampleCountPercentile`^Optional ```typescript public readonly evaluateLowSampleCountPercentile: boolean; ``` - *Type:* boolean - *Default:* true Used only for alarms based on percentiles. If you specify false, the alarm state does not change during periods with too few data points to be statistically significant. If you specify true, the alarm is always evaluated and possibly changes state no matter how many data points are available. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* the same as monitoring facade default Number of periods to consider when checking the number of breaching datapoints. --- ##### `fillAlarmRange`^Optional ```typescript public readonly fillAlarmRange: boolean; ``` - *Type:* boolean - *Default:* false Indicates whether the alarming range of values should be highlighted in the widget. --- ##### `metricAdjuster`^Optional ```typescript public readonly metricAdjuster: IMetricAdjuster; ``` - *Type:* IMetricAdjuster - *Default:* no adjuster If specified, adjusts the metric before creating an alarm from it. --- ##### ~~`minMetricSamplesToAlarm`~~^Optional - *Deprecated:* Use minSampleCountToEvaluateDatapoint instead. minMetricSamplesAlarm uses different evaluation period for its child alarms, so it doesn't guarantee that each datapoint in the evaluation period has sufficient number of samples ```typescript public readonly minMetricSamplesToAlarm: number; ``` - *Type:* number - *Default:* default behaviour - no condition on sample count will be added to the alarm Specifies how many samples (N) of the metric is needed to trigger the alarm. If this property is specified, a composite alarm is created of the following:

The original alarm, created without this property being used; this alarm will have no actions set.
A secondary alarm, which will monitor the same metric with the N (SampleCount) statistic, checking the sample count.

minSampleCountToEvaluateDatapoint is specified
the metric used for the alarm is a MathExpression
the MathExpression is composed of more than one metric

. In this situation, this property indicates the metric Id in the MathExpression’s usingMetrics property that should be used as the sampleCount metric for the new MathExpression as described in the documentation for minSampleCountToEvaluateDatapoint. --- ##### `treatMissingDataOverride`^Optional ```typescript public readonly treatMissingDataOverride: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* alarm-specific default Behaviour in case the metric data is missing. --- ##### `maxUsagePercent`^Required ```typescript public readonly maxUsagePercent: number; ``` - *Type:* number --- ### UserProvidedNames #### Initializer ```typescript import { UserProvidedNames } from 'cdk-monitoring-constructs' const userProvidedNames: UserProvidedNames = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ### WafV2AspectType #### Initializer ```typescript import { WafV2AspectType } from 'cdk-monitoring-constructs' const wafV2AspectType: WafV2AspectType = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enabled | boolean | If the monitoring aspect is enabled for this resource. | | props | WafV2MonitoringOptions | *No description.* | --- ##### `enabled`^Optional ```typescript public readonly enabled: boolean; ``` - *Type:* boolean - *Default:* true If the monitoring aspect is enabled for this resource. --- ##### `props`^Optional ```typescript public readonly props: WafV2MonitoringOptions; ``` - *Type:* WafV2MonitoringOptions --- ### WafV2MetricFactoryProps #### Initializer ```typescript import { WafV2MetricFactoryProps } from 'cdk-monitoring-constructs' const wafV2MetricFactoryProps: WafV2MetricFactoryProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | acl | aws-cdk-lib.aws_wafv2.CfnWebACL | Note that the "region" prop is required if this has a "REGIONAL" scope. | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `acl`^Required ```typescript public readonly acl: CfnWebACL; ``` - *Type:* aws-cdk-lib.aws_wafv2.CfnWebACL Note that the "region" prop is required if this has a "REGIONAL" scope. --- ### WafV2MonitoringOptions #### Initializer ```typescript import { WafV2MonitoringOptions } from 'cdk-monitoring-constructs' const wafV2MonitoringOptions: WafV2MonitoringOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | addBlockedRequestsCountAlarm | {[ key: string ]: ErrorCountThreshold} | *No description.* | | addBlockedRequestsRateAlarm | {[ key: string ]: ErrorRateThreshold} | *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addBlockedRequestsCountAlarm`^Optional ```typescript public readonly addBlockedRequestsCountAlarm: {[ key: string ]: ErrorCountThreshold}; ``` - *Type:* {[ key: string ]: ErrorCountThreshold} --- ##### `addBlockedRequestsRateAlarm`^Optional ```typescript public readonly addBlockedRequestsRateAlarm: {[ key: string ]: ErrorRateThreshold}; ``` - *Type:* {[ key: string ]: ErrorRateThreshold} --- ### WafV2MonitoringProps #### Initializer ```typescript import { WafV2MonitoringProps } from 'cdk-monitoring-constructs' const wafV2MonitoringProps: WafV2MonitoringProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | account | string | Account where the metrics exist. | | region | string | Region where the metrics exist. | | acl | aws-cdk-lib.aws_wafv2.CfnWebACL | Note that the "region" prop is required if this has a "REGIONAL" scope. | | alarmFriendlyName | string | Plain name, used in naming alarms. | | humanReadableName | string | Human-readable name is a freeform string, used as a caption or description. | | localAlarmNamePrefixOverride | string | If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. | | addToAlarmDashboard | boolean | Flag indicating if the widgets should be added to alarm dashboard. | | addToDetailDashboard | boolean | Flag indicating if the widgets should be added to detailed dashboard. | | addToSummaryDashboard | boolean | Flag indicating if the widgets should be added to summary dashboard. | | useCreatedAlarms | IAlarmConsumer | Calls provided function to process all alarms created. | | addBlockedRequestsCountAlarm | {[ key: string ]: ErrorCountThreshold} | *No description.* | | addBlockedRequestsRateAlarm | {[ key: string ]: ErrorRateThreshold} | *No description.* | --- ##### `account`^Optional ```typescript public readonly account: string; ``` - *Type:* string - *Default:* The account configured by the construct holding the Monitoring construct Account where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `region`^Optional ```typescript public readonly region: string; ``` - *Type:* string - *Default:* The region configured by the construct holding the Monitoring construct Region where the metrics exist. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html) --- ##### `acl`^Required ```typescript public readonly acl: CfnWebACL; ``` - *Type:* aws-cdk-lib.aws_wafv2.CfnWebACL Note that the "region" prop is required if this has a "REGIONAL" scope. --- ##### `alarmFriendlyName`^Optional ```typescript public readonly alarmFriendlyName: string; ``` - *Type:* string - *Default:* derives name from the construct itself Plain name, used in naming alarms. This unique among other resources, and respect the AWS CDK restriction posed on alarm names. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. --- ##### `humanReadableName`^Optional ```typescript public readonly humanReadableName: string; ``` - *Type:* string - *Default:* use alarmFriendlyName Human-readable name is a freeform string, used as a caption or description. There are no limitations on what it can be. --- ##### `localAlarmNamePrefixOverride`^Optional ```typescript public readonly localAlarmNamePrefixOverride: string; ``` - *Type:* string If this is defined, the local alarm name prefix used in naming alarms for the construct will be set to this value. The length must be 1 - 255 characters and although the validation rules are undocumented, we recommend using ASCII and hyphens. > [AlarmNamingStrategy for more details on alarm name prefixes](AlarmNamingStrategy for more details on alarm name prefixes) --- ##### `addToAlarmDashboard`^Optional ```typescript public readonly addToAlarmDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to alarm dashboard. --- ##### `addToDetailDashboard`^Optional ```typescript public readonly addToDetailDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to detailed dashboard. --- ##### `addToSummaryDashboard`^Optional ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean - *Default:* true Flag indicating if the widgets should be added to summary dashboard. --- ##### `useCreatedAlarms`^Optional ```typescript public readonly useCreatedAlarms: IAlarmConsumer; ``` - *Type:* IAlarmConsumer Calls provided function to process all alarms created. --- ##### `addBlockedRequestsCountAlarm`^Optional ```typescript public readonly addBlockedRequestsCountAlarm: {[ key: string ]: ErrorCountThreshold}; ``` - *Type:* {[ key: string ]: ErrorCountThreshold} --- ##### `addBlockedRequestsRateAlarm`^Optional ```typescript public readonly addBlockedRequestsRateAlarm: {[ key: string ]: ErrorRateThreshold}; ``` - *Type:* {[ key: string ]: ErrorRateThreshold} --- ## Classes ### AgeAlarmFactory #### Initializers ```typescript import { AgeAlarmFactory } from 'cdk-monitoring-constructs' new AgeAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addDaysSinceUpdateAlarm | *No description.* | | addDaysToExpiryAlarm | *No description.* | | addIteratorMaxAgeAlarm | *No description.* | | addMaxOffsetLagAlarm | *No description.* | --- ##### `addDaysSinceUpdateAlarm` ```typescript public addDaysSinceUpdateAlarm(metric: MathExpression | Metric, props: DaysSinceUpdateThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* DaysSinceUpdateThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addDaysToExpiryAlarm` ```typescript public addDaysToExpiryAlarm(metric: MathExpression | Metric, props: DaysToExpiryThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* DaysToExpiryThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addIteratorMaxAgeAlarm` ```typescript public addIteratorMaxAgeAlarm(metric: MathExpression | Metric, props: MaxAgeThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxAgeThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxOffsetLagAlarm` ```typescript public addMaxOffsetLagAlarm(metric: MathExpression | Metric, props: MaxOffsetLagThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxOffsetLagThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### AlarmFactory #### Initializers ```typescript import { AlarmFactory } from 'cdk-monitoring-constructs' new AlarmFactory(alarmScope: Construct, props: AlarmFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmScope | constructs.Construct | *No description.* | | props | AlarmFactoryProps | *No description.* | --- ##### `alarmScope`^Required - *Type:* constructs.Construct --- ##### `props`^Required - *Type:* AlarmFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | *No description.* | | addCompositeAlarm | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(metric: MathExpression | Metric, props: AddAlarmProps): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* AddAlarmProps --- ##### `addCompositeAlarm` ```typescript public addCompositeAlarm(alarms: AlarmWithAnnotation[], props: AddCompositeAlarmProps): CompositeAlarm ``` ###### `alarms`^Required - *Type:* AlarmWithAnnotation[] --- ###### `props`^Required - *Type:* AddCompositeAlarmProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | shouldUseDefaultDedupeForError | boolean | *No description.* | | shouldUseDefaultDedupeForLatency | boolean | *No description.* | --- ##### `shouldUseDefaultDedupeForError`^Required ```typescript public readonly shouldUseDefaultDedupeForError: boolean; ``` - *Type:* boolean --- ##### `shouldUseDefaultDedupeForLatency`^Required ```typescript public readonly shouldUseDefaultDedupeForLatency: boolean; ``` - *Type:* boolean --- ### AlarmMatrixWidget Wrapper of Alarm Status Widget which auto-calcultes height based on the number of alarms. Always takes the maximum width. #### Initializers ```typescript import { AlarmMatrixWidget } from 'cdk-monitoring-constructs' new AlarmMatrixWidget(props: AlarmMatrixWidgetProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | AlarmMatrixWidgetProps | *No description.* | --- ##### `props`^Required - *Type:* AlarmMatrixWidgetProps --- #### Methods | **Name** | **Description** | | --- | --- | | position | Place the widget at a given position. | | toJson | Return the widget JSON for use in the dashboard. | --- ##### `position` ```typescript public position(x: number, y: number): void ``` Place the widget at a given position. ###### `x`^Required - *Type:* number --- ###### `y`^Required - *Type:* number --- ##### `toJson` ```typescript public toJson(): any[] ``` Return the widget JSON for use in the dashboard. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | height | number | The amount of vertical grid units the widget will take up. | | width | number | The amount of horizontal grid units the widget will take up. | | warnings | string[] | Any warnings that are produced as a result of putting together this widget. | | warningsV2 | {[ key: string ]: string} | Any warnings that are produced as a result of putting together this widget. | --- ##### `height`^Required ```typescript public readonly height: number; ``` - *Type:* number The amount of vertical grid units the widget will take up. --- ##### `width`^Required ```typescript public readonly width: number; ``` - *Type:* number The amount of horizontal grid units the widget will take up. --- ##### `warnings`^Optional ```typescript public readonly warnings: string[]; ``` - *Type:* string[] Any warnings that are produced as a result of putting together this widget. --- ##### `warningsV2`^Optional ```typescript public readonly warningsV2: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Any warnings that are produced as a result of putting together this widget. --- ### AlarmNamingStrategy - *Implements:* IAlarmNamingStrategy #### Initializers ```typescript import { AlarmNamingStrategy } from 'cdk-monitoring-constructs' new AlarmNamingStrategy(globalPrefix: string, localPrefix: string, dedupeStringStrategy?: IAlarmDedupeStringProcessor) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | globalPrefix | string | *No description.* | | localPrefix | string | *No description.* | | dedupeStringStrategy | IAlarmDedupeStringProcessor | *No description.* | --- ##### `globalPrefix`^Required - *Type:* string --- ##### `localPrefix`^Required - *Type:* string --- ##### `dedupeStringStrategy`^Optional - *Type:* IAlarmDedupeStringProcessor --- #### Methods | **Name** | **Description** | | --- | --- | | getDedupeString | Dedupe string resolved like this: - If "dedupeStringOverride" is defined for an alarm, it will be used as a dedupe string. | | getName | Alarm name is resolved like this: - If "alarmNameOverride" is defined for an alarm, it will be used as alarm name. | | getWidgetLabel | How to generate the label for the alarm displayed on a widget. | --- ##### `getDedupeString` ```typescript public getDedupeString(props: AlarmNamingInput): string ``` Dedupe string resolved like this: - If "dedupeStringOverride" is defined for an alarm, it will be used as a dedupe string. If "alarmDedupeStringSuffix" from the alarm factory is defined, "GlobalPrefix-LocalPrefix-AlarmDedupeStringSuffix" will be used as a dedupe string. - Otherwise, the alarm dedupe string will not be set. If a dedupe string strategy is set, it will be used to process the final string. ###### `props`^Required - *Type:* AlarmNamingInput properties. --- ##### `getName` ```typescript public getName(props: AlarmNamingInput): string ``` Alarm name is resolved like this: - If "alarmNameOverride" is defined for an alarm, it will be used as alarm name. Otherwise, the alarm name will be generated by joining: global prefix, local prefix, alarm name suffix, disambiguator. ###### `props`^Required - *Type:* AlarmNamingInput properties. --- ##### `getWidgetLabel` ```typescript public getWidgetLabel(props: AlarmNamingInput): string ``` How to generate the label for the alarm displayed on a widget. ###### `props`^Required - *Type:* AlarmNamingInput --- ### AlarmSummaryMatrixWidget #### Initializers ```typescript import { AlarmSummaryMatrixWidget } from 'cdk-monitoring-constructs' new AlarmSummaryMatrixWidget(props: AlarmSummaryMatrixWidgetProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | AlarmSummaryMatrixWidgetProps | *No description.* | --- ##### `props`^Required - *Type:* AlarmSummaryMatrixWidgetProps --- #### Methods | **Name** | **Description** | | --- | --- | | position | Place the widget at a given position. | | toJson | Return the widget JSON for use in the dashboard. | --- ##### `position` ```typescript public position(x: number, y: number): void ``` Place the widget at a given position. ###### `x`^Required - *Type:* number --- ###### `y`^Required - *Type:* number --- ##### `toJson` ```typescript public toJson(): any[] ``` Return the widget JSON for use in the dashboard. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | height | number | The amount of vertical grid units the widget will take up. | | width | number | The amount of horizontal grid units the widget will take up. | | warnings | string[] | Any warnings that are produced as a result of putting together this widget. | | warningsV2 | {[ key: string ]: string} | Any warnings that are produced as a result of putting together this widget. | --- ##### `height`^Required ```typescript public readonly height: number; ``` - *Type:* number The amount of vertical grid units the widget will take up. --- ##### `width`^Required ```typescript public readonly width: number; ``` - *Type:* number The amount of horizontal grid units the widget will take up. --- ##### `warnings`^Optional ```typescript public readonly warnings: string[]; ``` - *Type:* string[] Any warnings that are produced as a result of putting together this widget. --- ##### `warningsV2`^Optional ```typescript public readonly warningsV2: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Any warnings that are produced as a result of putting together this widget. --- ### AnomalyDetectingAlarmFactory #### Initializers ```typescript import { AnomalyDetectingAlarmFactory } from 'cdk-monitoring-constructs' new AnomalyDetectingAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarmWhenOutOfBand | *No description.* | --- ##### `addAlarmWhenOutOfBand` ```typescript public addAlarmWhenOutOfBand(metric: MathExpression | Metric, alarmNameSuffix: string, disambiguator: string, props: AnomalyDetectionThreshold): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `alarmNameSuffix`^Required - *Type:* string --- ###### `disambiguator`^Required - *Type:* string --- ###### `props`^Required - *Type:* AnomalyDetectionThreshold --- ### AnomalyDetectionMathExpression Captures specific MathExpression for anomaly detection, for which alarm generation is different. Added to overcome certain CDK limitations at the time of writing. > [https://github.com/aws/aws-cdk/issues/10540](https://github.com/aws/aws-cdk/issues/10540) #### Initializers ```typescript import { AnomalyDetectionMathExpression } from 'cdk-monitoring-constructs' new AnomalyDetectionMathExpression(props: MathExpressionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | aws-cdk-lib.aws_cloudwatch.MathExpressionProps | *No description.* | --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpressionProps --- #### Methods | **Name** | **Description** | | --- | --- | | createAlarm | Make a new Alarm for this metric. | | toMetricConfig | Inspect the details of the metric object. | | toString | Returns a string representation of an object. | | with | Return a copy of Metric with properties changed. | --- ##### `createAlarm` ```typescript public createAlarm(scope: Construct, id: string, props: CreateAlarmOptions): Alarm ``` Make a new Alarm for this metric. Combines both properties that may adjust the metric (aggregation) as well as alarm properties. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.CreateAlarmOptions --- ##### `toMetricConfig` ```typescript public toMetricConfig(): MetricConfig ``` Inspect the details of the metric object. ##### `toString` ```typescript public toString(): string ``` Returns a string representation of an object. ##### `with` ```typescript public with(props: MathExpressionOptions): MathExpression ``` Return a copy of Metric with properties changed. All properties except namespace and metricName can be changed. ###### `props`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpressionOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | expression | string | The expression defining the metric. | | period | aws-cdk-lib.Duration | Aggregation period of this metric. | | usingMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.IMetric} | The metrics used in the expression as KeyValuePair . | | color | string | The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The `Color` class has a set of standard colors that can be used here. | | label | string | Label for this metric when added to a Graph. | | searchAccount | string | Account to evaluate search expressions within. | | searchRegion | string | Region to evaluate search expressions within. | | warnings | string[] | Warnings generated by this math expression. | | warningsV2 | {[ key: string ]: string} | Warnings generated by this math expression. | --- ##### `expression`^Required ```typescript public readonly expression: string; ``` - *Type:* string The expression defining the metric. --- ##### `period`^Required ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration Aggregation period of this metric. --- ##### `usingMetrics`^Required ```typescript public readonly usingMetrics: {[ key: string ]: IMetric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.IMetric} The metrics used in the expression as KeyValuePair . --- ##### `color`^Optional ```typescript public readonly color: string; ``` - *Type:* string The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The `Color` class has a set of standard colors that can be used here. --- ##### `label`^Optional ```typescript public readonly label: string; ``` - *Type:* string Label for this metric when added to a Graph. --- ##### `searchAccount`^Optional ```typescript public readonly searchAccount: string; ``` - *Type:* string Account to evaluate search expressions within. --- ##### `searchRegion`^Optional ```typescript public readonly searchRegion: string; ``` - *Type:* string Region to evaluate search expressions within. --- ##### ~~`warnings`~~^Optional - *Deprecated:* - use warningsV2 ```typescript public readonly warnings: string[]; ``` - *Type:* string[] Warnings generated by this math expression. --- ##### `warningsV2`^Optional ```typescript public readonly warningsV2: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Warnings generated by this math expression. --- ### ApiGatewayMetricFactory #### Initializers ```typescript import { ApiGatewayMetricFactory } from 'cdk-monitoring-constructs' new ApiGatewayMetricFactory(metricFactory: MetricFactory, props: ApiGatewayMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | ApiGatewayMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* ApiGatewayMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metric4XXErrorCount | *No description.* | | metric4XXErrorRate | *No description.* | | metric5XXFaultCount | *No description.* | | metric5XXFaultRate | *No description.* | | metricInvocationCount | *No description.* | | metricInvocationRate | *No description.* | | metricLatencyInMillis | *No description.* | | metricLatencyP50InMillis | *No description.* | | metricLatencyP90InMillis | *No description.* | | metricLatencyP99InMillis | *No description.* | | metricTps | *No description.* | --- ##### `metric4XXErrorCount` ```typescript public metric4XXErrorCount(): MathExpression | Metric ``` ##### `metric4XXErrorRate` ```typescript public metric4XXErrorRate(): MathExpression | Metric ``` ##### `metric5XXFaultCount` ```typescript public metric5XXFaultCount(): MathExpression | Metric ``` ##### `metric5XXFaultRate` ```typescript public metric5XXFaultRate(): MathExpression | Metric ``` ##### `metricInvocationCount` ```typescript public metricInvocationCount(): MathExpression | Metric ``` ##### `metricInvocationRate` ```typescript public metricInvocationRate(rateComputationMethod?: RateComputationMethod): MathExpression | Metric ``` ###### `rateComputationMethod`^Optional - *Type:* RateComputationMethod --- ##### `metricLatencyInMillis` ```typescript public metricLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### ~~`metricLatencyP50InMillis`~~ ```typescript public metricLatencyP50InMillis(): MathExpression | Metric ``` ##### ~~`metricLatencyP90InMillis`~~ ```typescript public metricLatencyP90InMillis(): MathExpression | Metric ``` ##### ~~`metricLatencyP99InMillis`~~ ```typescript public metricLatencyP99InMillis(): MathExpression | Metric ``` ##### ~~`metricTps`~~ ```typescript public metricTps(): MathExpression | Metric ``` ### ApiGatewayMonitoring #### Initializers ```typescript import { ApiGatewayMonitoring } from 'cdk-monitoring-constructs' new ApiGatewayMonitoring(scope: MonitoringScope, props: ApiGatewayMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | ApiGatewayMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* ApiGatewayMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createErrorCountWidget | *No description.* | | createErrorRateWidget | *No description.* | | createLatencyWidget | *No description.* | | createTitleWidget | *No description.* | | createTpsWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createErrorCountWidget` ```typescript public createErrorCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createErrorRateWidget` ```typescript public createErrorRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### `createTpsWidget` ```typescript public createTpsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | error4XXCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | error4XXRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | fault5XXCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | fault5XXRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | latencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | latencyMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric} | *No description.* | | latencyTypesToRender | string[] | *No description.* | | title | string | *No description.* | | tpsAlarmFactory | TpsAlarmFactory | *No description.* | | tpsAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | tpsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `error4XXCountMetric`^Required ```typescript public readonly error4XXCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `error4XXRateMetric`^Required ```typescript public readonly error4XXRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `fault5XXCountMetric`^Required ```typescript public readonly fault5XXCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `fault5XXRateMetric`^Required ```typescript public readonly fault5XXRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `latencyAnnotations`^Required ```typescript public readonly latencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `latencyMetrics`^Required ```typescript public readonly latencyMetrics: {[ key: string ]: MathExpression | Metric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric} --- ##### `latencyTypesToRender`^Required ```typescript public readonly latencyTypesToRender: string[]; ``` - *Type:* string[] --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `tpsAlarmFactory`^Required ```typescript public readonly tpsAlarmFactory: TpsAlarmFactory; ``` - *Type:* TpsAlarmFactory --- ##### `tpsAnnotations`^Required ```typescript public readonly tpsAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `tpsMetric`^Required ```typescript public readonly tpsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ### ApiGatewayV2HttpApiMetricFactory #### Initializers ```typescript import { ApiGatewayV2HttpApiMetricFactory } from 'cdk-monitoring-constructs' new ApiGatewayV2HttpApiMetricFactory(metricFactory: MetricFactory, props: ApiGatewayV2HttpApiMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | ApiGatewayV2HttpApiMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* ApiGatewayV2HttpApiMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metric4xxCount | *No description.* | | metric4xxRate | *No description.* | | metric5xxCount | *No description.* | | metric5xxRate | *No description.* | | metricIntegrationLatencyInMillis | *No description.* | | metricIntegrationLatencyP50InMillis | *No description.* | | metricIntegrationLatencyP90InMillis | *No description.* | | metricIntegrationLatencyP99InMillis | *No description.* | | metricInvocationCount | *No description.* | | metricInvocationRate | *No description.* | | metricLatencyInMillis | *No description.* | | metricLatencyP50InMillis | *No description.* | | metricLatencyP90InMillis | *No description.* | | metricLatencyP99InMillis | *No description.* | | metricTps | *No description.* | --- ##### `metric4xxCount` ```typescript public metric4xxCount(): MathExpression | Metric ``` ##### `metric4xxRate` ```typescript public metric4xxRate(): MathExpression | Metric ``` ##### `metric5xxCount` ```typescript public metric5xxCount(): MathExpression | Metric ``` ##### `metric5xxRate` ```typescript public metric5xxRate(): MathExpression | Metric ``` ##### `metricIntegrationLatencyInMillis` ```typescript public metricIntegrationLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### ~~`metricIntegrationLatencyP50InMillis`~~ ```typescript public metricIntegrationLatencyP50InMillis(): MathExpression | Metric ``` ##### ~~`metricIntegrationLatencyP90InMillis`~~ ```typescript public metricIntegrationLatencyP90InMillis(): MathExpression | Metric ``` ##### ~~`metricIntegrationLatencyP99InMillis`~~ ```typescript public metricIntegrationLatencyP99InMillis(): MathExpression | Metric ``` ##### `metricInvocationCount` ```typescript public metricInvocationCount(): MathExpression | Metric ``` ##### `metricInvocationRate` ```typescript public metricInvocationRate(rateComputationMethod?: RateComputationMethod): MathExpression | Metric ``` ###### `rateComputationMethod`^Optional - *Type:* RateComputationMethod --- ##### `metricLatencyInMillis` ```typescript public metricLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### ~~`metricLatencyP50InMillis`~~ ```typescript public metricLatencyP50InMillis(): MathExpression | Metric ``` ##### ~~`metricLatencyP90InMillis`~~ ```typescript public metricLatencyP90InMillis(): MathExpression | Metric ``` ##### ~~`metricLatencyP99InMillis`~~ ```typescript public metricLatencyP99InMillis(): MathExpression | Metric ``` ##### ~~`metricTps`~~ ```typescript public metricTps(): MathExpression | Metric ``` ### ApiGatewayV2HttpApiMonitoring #### Initializers ```typescript import { ApiGatewayV2HttpApiMonitoring } from 'cdk-monitoring-constructs' new ApiGatewayV2HttpApiMonitoring(scope: MonitoringScope, props: ApiGatewayV2HttpApiMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | ApiGatewayV2HttpApiMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* ApiGatewayV2HttpApiMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createErrorCountWidget | *No description.* | | createErrorRateWidget | *No description.* | | createLatencyWidget | *No description.* | | createTitleWidget | *No description.* | | createTpsWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createErrorCountWidget` ```typescript public createErrorCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createErrorRateWidget` ```typescript public createErrorRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### `createTpsWidget` ```typescript public createTpsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | error4xxCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | error4xxRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | error5xxCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | error5xxRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | integrationLatencyMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric} | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | latencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | latencyMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric} | *No description.* | | latencyTypesToRender | string[] | *No description.* | | title | string | *No description.* | | tpsAlarmFactory | TpsAlarmFactory | *No description.* | | tpsAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | tpsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `error4xxCountMetric`^Required ```typescript public readonly error4xxCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `error4xxRateMetric`^Required ```typescript public readonly error4xxRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `error5xxCountMetric`^Required ```typescript public readonly error5xxCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `error5xxRateMetric`^Required ```typescript public readonly error5xxRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `integrationLatencyMetrics`^Required ```typescript public readonly integrationLatencyMetrics: {[ key: string ]: MathExpression | Metric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric} --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `latencyAnnotations`^Required ```typescript public readonly latencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `latencyMetrics`^Required ```typescript public readonly latencyMetrics: {[ key: string ]: MathExpression | Metric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric} --- ##### `latencyTypesToRender`^Required ```typescript public readonly latencyTypesToRender: string[]; ``` - *Type:* string[] --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `tpsAlarmFactory`^Required ```typescript public readonly tpsAlarmFactory: TpsAlarmFactory; ``` - *Type:* TpsAlarmFactory --- ##### `tpsAnnotations`^Required ```typescript public readonly tpsAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `tpsMetric`^Required ```typescript public readonly tpsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ### ApplicationLoadBalancerMetricFactory - *Implements:* ILoadBalancerMetricFactory Metric factory to create metrics for application load-balanced service. #### Initializers ```typescript import { ApplicationLoadBalancerMetricFactory } from 'cdk-monitoring-constructs' new ApplicationLoadBalancerMetricFactory(metricFactory: MetricFactory, props: ApplicationLoadBalancerMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | ApplicationLoadBalancerMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* ApplicationLoadBalancerMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricActiveConnectionCount | *No description.* | | metricHealthyTaskCount | *No description.* | | metricHealthyTaskInPercent | *No description.* | | metricNewConnectionCount | *No description.* | | metricProcessedBytesMin | *No description.* | | metricUnhealthyRoutingCount | *No description.* | | metricUnhealthyTaskCount | *No description.* | --- ##### `metricActiveConnectionCount` ```typescript public metricActiveConnectionCount(): MathExpression | Metric ``` ##### `metricHealthyTaskCount` ```typescript public metricHealthyTaskCount(): MathExpression | Metric ``` ##### `metricHealthyTaskInPercent` ```typescript public metricHealthyTaskInPercent(): MathExpression | Metric ``` ##### `metricNewConnectionCount` ```typescript public metricNewConnectionCount(): MathExpression | Metric ``` ##### `metricProcessedBytesMin` ```typescript public metricProcessedBytesMin(): MathExpression | Metric ``` ##### `metricUnhealthyRoutingCount` ```typescript public metricUnhealthyRoutingCount(): MathExpression | Metric ``` ##### `metricUnhealthyTaskCount` ```typescript public metricUnhealthyTaskCount(): MathExpression | Metric ``` ### AppSyncMetricFactory #### Initializers ```typescript import { AppSyncMetricFactory } from 'cdk-monitoring-constructs' new AppSyncMetricFactory(metricFactory: MetricFactory, props: AppSyncMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | AppSyncMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* AppSyncMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metric4XXErrorCount | *No description.* | | metric4XXErrorRate | *No description.* | | metric5XXFaultCount | *No description.* | | metric5XXFaultRate | *No description.* | | metricLatencyP50InMillis | *No description.* | | metricLatencyP90InMillis | *No description.* | | metricLatencyP99InMillis | *No description.* | | metricRequestCount | *No description.* | | metricRequestRate | *No description.* | | metricTps | *No description.* | --- ##### `metric4XXErrorCount` ```typescript public metric4XXErrorCount(): MathExpression | Metric ``` ##### `metric4XXErrorRate` ```typescript public metric4XXErrorRate(): MathExpression | Metric ``` ##### `metric5XXFaultCount` ```typescript public metric5XXFaultCount(): MathExpression | Metric ``` ##### `metric5XXFaultRate` ```typescript public metric5XXFaultRate(): MathExpression | Metric ``` ##### `metricLatencyP50InMillis` ```typescript public metricLatencyP50InMillis(): MathExpression | Metric ``` ##### `metricLatencyP90InMillis` ```typescript public metricLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricLatencyP99InMillis` ```typescript public metricLatencyP99InMillis(): MathExpression | Metric ``` ##### `metricRequestCount` ```typescript public metricRequestCount(): MathExpression | Metric ``` ##### `metricRequestRate` ```typescript public metricRequestRate(rateComputationMethod?: RateComputationMethod): MathExpression | Metric ``` ###### `rateComputationMethod`^Optional - *Type:* RateComputationMethod --- ##### ~~`metricTps`~~ ```typescript public metricTps(): MathExpression | Metric ``` ### AppSyncMonitoring #### Initializers ```typescript import { AppSyncMonitoring } from 'cdk-monitoring-constructs' new AppSyncMonitoring(scope: MonitoringScope, props: AppSyncMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | AppSyncMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* AppSyncMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createErrorCountWidget | *No description.* | | createErrorRateWidget | *No description.* | | createLatencyWidget | *No description.* | | createTpsWidget | *No description.* | | createtTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createErrorCountWidget` ```typescript public createErrorCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createErrorRateWidget` ```typescript public createErrorRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTpsWidget` ```typescript public createTpsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createtTitleWidget` ```typescript public createtTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | error4xxCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | error4xxRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | fault5xxCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | fault5xxRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | latencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | metricFactory | AppSyncMetricFactory | *No description.* | | namingStrategy | MonitoringNamingStrategy | *No description.* | | p50LatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p90LatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p99LatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | tpsAlarmFactory | TpsAlarmFactory | *No description.* | | tpsAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | tpsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `error4xxCountMetric`^Required ```typescript public readonly error4xxCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `error4xxRateMetric`^Required ```typescript public readonly error4xxRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `fault5xxCountMetric`^Required ```typescript public readonly fault5xxCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `fault5xxRateMetric`^Required ```typescript public readonly fault5xxRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `latencyAnnotations`^Required ```typescript public readonly latencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `metricFactory`^Required ```typescript public readonly metricFactory: AppSyncMetricFactory; ``` - *Type:* AppSyncMetricFactory --- ##### `namingStrategy`^Required ```typescript public readonly namingStrategy: MonitoringNamingStrategy; ``` - *Type:* MonitoringNamingStrategy --- ##### `p50LatencyMetric`^Required ```typescript public readonly p50LatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p90LatencyMetric`^Required ```typescript public readonly p90LatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p99LatencyMetric`^Required ```typescript public readonly p99LatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `tpsAlarmFactory`^Required ```typescript public readonly tpsAlarmFactory: TpsAlarmFactory; ``` - *Type:* TpsAlarmFactory --- ##### `tpsAnnotations`^Required ```typescript public readonly tpsAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `tpsMetric`^Required ```typescript public readonly tpsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ### AuroraAlarmFactory #### Initializers ```typescript import { AuroraAlarmFactory } from 'cdk-monitoring-constructs' new AuroraAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addMaxServerlessDatabaseCapacity | *No description.* | --- ##### `addMaxServerlessDatabaseCapacity` ```typescript public addMaxServerlessDatabaseCapacity(metric: MathExpression | Metric, props: HighServerlessDatabaseCapacityThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* HighServerlessDatabaseCapacityThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### AuroraClusterMonitoring #### Initializers ```typescript import { AuroraClusterMonitoring } from 'cdk-monitoring-constructs' new AuroraClusterMonitoring(scope: MonitoringScope, props: AuroraClusterMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | AuroraClusterMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* AuroraClusterMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createConnectionsWidget | *No description.* | | createCpuUsageWidget | *No description.* | | createLatencyWidget | *No description.* | | createServerlessDatabaseCapacityWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createConnectionsWidget` ```typescript public createConnectionsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createCpuUsageWidget` ```typescript public createCpuUsageWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createServerlessDatabaseCapacityWidget` ```typescript public createServerlessDatabaseCapacityWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | commitLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | connectionAlarmFactory | ConnectionAlarmFactory | *No description.* | | connectionAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | connectionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | deleteLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | insertLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | selectLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | serverlessCapacityAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | serverlessDatabaseCapacityMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | updateLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | usageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | url | string | *No description.* | --- ##### `commitLatencyMetric`^Required ```typescript public readonly commitLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `connectionAlarmFactory`^Required ```typescript public readonly connectionAlarmFactory: ConnectionAlarmFactory; ``` - *Type:* ConnectionAlarmFactory --- ##### `connectionAnnotations`^Required ```typescript public readonly connectionAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `connectionsMetric`^Required ```typescript public readonly connectionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageMetric`^Required ```typescript public readonly cpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `deleteLatencyMetric`^Required ```typescript public readonly deleteLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `insertLatencyMetric`^Required ```typescript public readonly insertLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `selectLatencyMetric`^Required ```typescript public readonly selectLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `serverlessCapacityAnnotations`^Required ```typescript public readonly serverlessCapacityAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `serverlessDatabaseCapacityMetric`^Required ```typescript public readonly serverlessDatabaseCapacityMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `updateLatencyMetric`^Required ```typescript public readonly updateLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `usageAnnotations`^Required ```typescript public readonly usageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string --- ### AutoScalingGroupMetricFactory #### Initializers ```typescript import { AutoScalingGroupMetricFactory } from 'cdk-monitoring-constructs' new AutoScalingGroupMetricFactory(metricFactory: MetricFactory, props: AutoScalingGroupMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | AutoScalingGroupMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* AutoScalingGroupMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricGroupDesiredCapacity | The number of instances that the Auto Scaling group attempts to maintain. | | metricGroupInServiceInstances | The number of instances that are running as part of the Auto Scaling group. | | metricGroupMaxSize | The maximum size of the Auto Scaling group. | | metricGroupMinSize | The minimum size of the Auto Scaling group. | | metricGroupPendingInstances | The number of instances that are pending. | | metricGroupStandbyInstances | The number of instances that are in a Standby state. | | metricGroupTerminatingInstances | The number of instances that are in the process of terminating. | | metricGroupTotalInstances | The total number of instances in the Auto Scaling group. | --- ##### `metricGroupDesiredCapacity` ```typescript public metricGroupDesiredCapacity(): MathExpression | Metric ``` The number of instances that the Auto Scaling group attempts to maintain. ##### `metricGroupInServiceInstances` ```typescript public metricGroupInServiceInstances(): MathExpression | Metric ``` The number of instances that are running as part of the Auto Scaling group. This metric does not include instances that are pending or terminating. ##### `metricGroupMaxSize` ```typescript public metricGroupMaxSize(): MathExpression | Metric ``` The maximum size of the Auto Scaling group. ##### `metricGroupMinSize` ```typescript public metricGroupMinSize(): MathExpression | Metric ``` The minimum size of the Auto Scaling group. ##### `metricGroupPendingInstances` ```typescript public metricGroupPendingInstances(): MathExpression | Metric ``` The number of instances that are pending. A pending instance is not yet in service. This metric does not include instances that are in service or terminating. ##### `metricGroupStandbyInstances` ```typescript public metricGroupStandbyInstances(): MathExpression | Metric ``` The number of instances that are in a Standby state. Instances in this state are still running but are not actively in service. ##### `metricGroupTerminatingInstances` ```typescript public metricGroupTerminatingInstances(): MathExpression | Metric ``` The number of instances that are in the process of terminating. This metric does not include instances that are in service or pending. ##### `metricGroupTotalInstances` ```typescript public metricGroupTotalInstances(): MathExpression | Metric ``` The total number of instances in the Auto Scaling group. This metric identifies the number of instances that are in service, pending, and terminating. ### AutoScalingGroupMonitoring #### Initializers ```typescript import { AutoScalingGroupMonitoring } from 'cdk-monitoring-constructs' new AutoScalingGroupMonitoring(scope: MonitoringScope, props: AutoScalingGroupMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | AutoScalingGroupMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* AutoScalingGroupMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createGroupSizeWidget | *No description.* | | createGroupStatusWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createGroupSizeWidget` ```typescript public createGroupSizeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createGroupStatusWidget` ```typescript public createGroupStatusWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | groupDesiredSizeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | groupMaxSizeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | groupMinSizeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | instancesInServiceMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | instancesPendingMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | instancesStandbyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | instancesTerminatingMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | instancesTotalMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | --- ##### `groupDesiredSizeMetric`^Required ```typescript public readonly groupDesiredSizeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `groupMaxSizeMetric`^Required ```typescript public readonly groupMaxSizeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `groupMinSizeMetric`^Required ```typescript public readonly groupMinSizeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `instancesInServiceMetric`^Required ```typescript public readonly instancesInServiceMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `instancesPendingMetric`^Required ```typescript public readonly instancesPendingMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `instancesStandbyMetric`^Required ```typescript public readonly instancesStandbyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `instancesTerminatingMetric`^Required ```typescript public readonly instancesTerminatingMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `instancesTotalMetric`^Required ```typescript public readonly instancesTotalMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ### AwsConsoleUrlFactory #### Initializers ```typescript import { AwsConsoleUrlFactory } from 'cdk-monitoring-constructs' new AwsConsoleUrlFactory(props: AwsConsoleUrlFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | AwsConsoleUrlFactoryProps | *No description.* | --- ##### `props`^Required - *Type:* AwsConsoleUrlFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | getApiGatewayUrl | *No description.* | | getAwsConsoleUrl | *No description.* | | getCloudFrontDistributionUrl | *No description.* | | getCloudWatchLogGroupUrl | *No description.* | | getCodeBuildProjectUrl | *No description.* | | getDocumentDbClusterUrl | *No description.* | | getDynamoTableUrl | *No description.* | | getElastiCacheClusterUrl | *No description.* | | getKinesisAnalyticsUrl | *No description.* | | getKinesisDataStreamUrl | *No description.* | | getKinesisFirehoseDeliveryStreamUrl | *No description.* | | getLambdaFunctionUrl | *No description.* | | getOpenSearchClusterUrl | *No description.* | | getOpenSearchServerlessCollectionUrl | *No description.* | | getOsisPipelineUrl | *No description.* | | getRdsClusterUrl | *No description.* | | getRdsInstanceUrl | *No description.* | | getRedshiftClusterUrl | *No description.* | | getS3BucketUrl | *No description.* | | getSnsTopicUrl | *No description.* | | getSqsQueueUrl | *No description.* | | getStateMachineUrl | *No description.* | --- ##### `getApiGatewayUrl` ```typescript public getApiGatewayUrl(restApiId: string): string ``` ###### `restApiId`^Required - *Type:* string --- ##### `getAwsConsoleUrl` ```typescript public getAwsConsoleUrl(destinationUrl?: string): string ``` ###### `destinationUrl`^Optional - *Type:* string --- ##### `getCloudFrontDistributionUrl` ```typescript public getCloudFrontDistributionUrl(distributionId: string): string ``` ###### `distributionId`^Required - *Type:* string --- ##### `getCloudWatchLogGroupUrl` ```typescript public getCloudWatchLogGroupUrl(logGroupName: string): string ``` ###### `logGroupName`^Required - *Type:* string --- ##### `getCodeBuildProjectUrl` ```typescript public getCodeBuildProjectUrl(projectName: string): string ``` ###### `projectName`^Required - *Type:* string --- ##### `getDocumentDbClusterUrl` ```typescript public getDocumentDbClusterUrl(clusterId: string): string ``` ###### `clusterId`^Required - *Type:* string --- ##### `getDynamoTableUrl` ```typescript public getDynamoTableUrl(tableName: string): string ``` ###### `tableName`^Required - *Type:* string --- ##### `getElastiCacheClusterUrl` ```typescript public getElastiCacheClusterUrl(clusterId: string, clusterType: ElastiCacheClusterType): string ``` ###### `clusterId`^Required - *Type:* string --- ###### `clusterType`^Required - *Type:* ElastiCacheClusterType --- ##### `getKinesisAnalyticsUrl` ```typescript public getKinesisAnalyticsUrl(application: string): string ``` ###### `application`^Required - *Type:* string --- ##### `getKinesisDataStreamUrl` ```typescript public getKinesisDataStreamUrl(streamName: string): string ``` ###### `streamName`^Required - *Type:* string --- ##### `getKinesisFirehoseDeliveryStreamUrl` ```typescript public getKinesisFirehoseDeliveryStreamUrl(streamName: string): string ``` ###### `streamName`^Required - *Type:* string --- ##### `getLambdaFunctionUrl` ```typescript public getLambdaFunctionUrl(functionName: string): string ``` ###### `functionName`^Required - *Type:* string --- ##### `getOpenSearchClusterUrl` ```typescript public getOpenSearchClusterUrl(domainName: string): string ``` ###### `domainName`^Required - *Type:* string --- ##### `getOpenSearchServerlessCollectionUrl` ```typescript public getOpenSearchServerlessCollectionUrl(collectionName: string): string ``` ###### `collectionName`^Required - *Type:* string --- ##### `getOsisPipelineUrl` ```typescript public getOsisPipelineUrl(pipelineName: string): string ``` ###### `pipelineName`^Required - *Type:* string --- ##### `getRdsClusterUrl` ```typescript public getRdsClusterUrl(clusterId: string): string ``` ###### `clusterId`^Required - *Type:* string --- ##### `getRdsInstanceUrl` ```typescript public getRdsInstanceUrl(instanceId: string): string ``` ###### `instanceId`^Required - *Type:* string --- ##### `getRedshiftClusterUrl` ```typescript public getRedshiftClusterUrl(clusterId: string): string ``` ###### `clusterId`^Required - *Type:* string --- ##### `getS3BucketUrl` ```typescript public getS3BucketUrl(bucketName: string): string ``` ###### `bucketName`^Required - *Type:* string --- ##### `getSnsTopicUrl` ```typescript public getSnsTopicUrl(topicArn: string): string ``` ###### `topicArn`^Required - *Type:* string --- ##### `getSqsQueueUrl` ```typescript public getSqsQueueUrl(queueUrl: string): string ``` ###### `queueUrl`^Required - *Type:* string --- ##### `getStateMachineUrl` ```typescript public getStateMachineUrl(stateMachineArn: string): string ``` ###### `stateMachineArn`^Required - *Type:* string --- ### BaseMetricFactory #### Initializers ```typescript import { BaseMetricFactory } from 'cdk-monitoring-constructs' new BaseMetricFactory(metricFactory: MetricFactory, props: BaseMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | BaseMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* BaseMetricFactoryProps --- ### BaseServiceMetricFactory Metric factory for a base service (parent class for e.g. Fargate and EC2 services). #### Initializers ```typescript import { BaseServiceMetricFactory } from 'cdk-monitoring-constructs' new BaseServiceMetricFactory(metricFactory: MetricFactory, props: BaseServiceMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | BaseServiceMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* BaseServiceMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricClusterCpuUtilisationInPercent | *No description.* | | metricClusterMemoryUtilisationInPercent | *No description.* | | metricEphemeralStorageReserved | *No description.* | | metricEphemeralStorageUsageInPercent | *No description.* | | metricEphemeralStorageUtilized | *No description.* | | metricRunningTaskCount | *No description.* | --- ##### `metricClusterCpuUtilisationInPercent` ```typescript public metricClusterCpuUtilisationInPercent(statistic?: MetricStatistic): MathExpression | Metric ``` ###### `statistic`^Optional - *Type:* MetricStatistic --- ##### `metricClusterMemoryUtilisationInPercent` ```typescript public metricClusterMemoryUtilisationInPercent(statistic?: MetricStatistic): MathExpression | Metric ``` ###### `statistic`^Optional - *Type:* MetricStatistic --- ##### `metricEphemeralStorageReserved` ```typescript public metricEphemeralStorageReserved(): MathExpression | Metric ``` ##### `metricEphemeralStorageUsageInPercent` ```typescript public metricEphemeralStorageUsageInPercent(): MathExpression | Metric ``` ##### `metricEphemeralStorageUtilized` ```typescript public metricEphemeralStorageUtilized(): MathExpression | Metric ``` ##### `metricRunningTaskCount` ```typescript public metricRunningTaskCount(): MathExpression | Metric ``` ### BillingMetricFactory #### Initializers ```typescript import { BillingMetricFactory } from 'cdk-monitoring-constructs' new BillingMetricFactory() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | metricSearchTopCostByServiceInUsd | *No description.* | | metricTotalCostInUsd | *No description.* | --- ##### `metricSearchTopCostByServiceInUsd` ```typescript public metricSearchTopCostByServiceInUsd(): IMetric ``` ##### `metricTotalCostInUsd` ```typescript public metricTotalCostInUsd(): MathExpression | Metric ``` ### BillingMonitoring #### Initializers ```typescript import { BillingMonitoring } from 'cdk-monitoring-constructs' new BillingMonitoring(scope: MonitoringScope, props: BillingMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | BillingMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* BillingMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createChargesByServiceWidget | *No description.* | | createTitleWidget | *No description.* | | createTotalChargesWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createChargesByServiceWidget` ```typescript public createChargesByServiceWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### `createTotalChargesWidget` ```typescript public createTotalChargesWidget(width: number, height: number): SingleValueWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | anomalyDetectingAlarmFactory | AnomalyDetectingAlarmFactory | *No description.* | | costByServiceMetric | aws-cdk-lib.aws_cloudwatch.IMetric | *No description.* | | title | string | *No description.* | | totalCostMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `anomalyDetectingAlarmFactory`^Required ```typescript public readonly anomalyDetectingAlarmFactory: AnomalyDetectingAlarmFactory; ``` - *Type:* AnomalyDetectingAlarmFactory --- ##### `costByServiceMetric`^Required ```typescript public readonly costByServiceMetric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `totalCostMetric`^Required ```typescript public readonly totalCostMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ### CertificateManagerMetricFactory #### Initializers ```typescript import { CertificateManagerMetricFactory } from 'cdk-monitoring-constructs' new CertificateManagerMetricFactory(metricFactory: MetricFactory, props: CertificateManagerMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | CertificateManagerMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* CertificateManagerMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricDaysToExpiry | *No description.* | --- ##### `metricDaysToExpiry` ```typescript public metricDaysToExpiry(): MathExpression | Metric ``` ### CertificateManagerMonitoring #### Initializers ```typescript import { CertificateManagerMonitoring } from 'cdk-monitoring-constructs' new CertificateManagerMonitoring(scope: MonitoringScope, props: CertificateManagerMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | CertificateManagerMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* CertificateManagerMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createDaysToExpiryWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createDaysToExpiryWidget` ```typescript public createDaysToExpiryWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | daysToExpiryAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | daysToExpiryMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | --- ##### `daysToExpiryAnnotations`^Required ```typescript public readonly daysToExpiryAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `daysToExpiryMetric`^Required ```typescript public readonly daysToExpiryMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ### CloudFrontDistributionMetricFactory To get the CloudFront metrics from the CloudWatch API, you must use the US East (N. Virginia) Region (us-east-1). https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/programming-cloudwatch-metrics.html #### Initializers ```typescript import { CloudFrontDistributionMetricFactory } from 'cdk-monitoring-constructs' new CloudFrontDistributionMetricFactory(metricFactory: MetricFactory, props: CloudFrontDistributionMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | CloudFrontDistributionMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* CloudFrontDistributionMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metric4xxErrorRateAverage | *No description.* | | metric5xxErrorRateAverage | *No description.* | | metricCacheHitRateAverageInPercent | Cache hit rate metric. | | metricRequestCount | *No description.* | | metricRequestRate | *No description.* | | metricRequestTps | *No description.* | | metricTotalBytesDownloaded | *No description.* | | metricTotalBytesUploaded | *No description.* | | metricTotalErrorRateAverage | *No description.* | --- ##### `metric4xxErrorRateAverage` ```typescript public metric4xxErrorRateAverage(): MathExpression | Metric ``` ##### `metric5xxErrorRateAverage` ```typescript public metric5xxErrorRateAverage(): MathExpression | Metric ``` ##### `metricCacheHitRateAverageInPercent` ```typescript public metricCacheHitRateAverageInPercent(): MathExpression | Metric ``` Cache hit rate metric. This is an additional metric that needs to be explicitly enabled for an additional cost. > [https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional) ##### `metricRequestCount` ```typescript public metricRequestCount(): MathExpression | Metric ``` ##### `metricRequestRate` ```typescript public metricRequestRate(rateComputationMethod?: RateComputationMethod): MathExpression | Metric ``` ###### `rateComputationMethod`^Optional - *Type:* RateComputationMethod --- ##### ~~`metricRequestTps`~~ ```typescript public metricRequestTps(): MathExpression | Metric ``` ##### `metricTotalBytesDownloaded` ```typescript public metricTotalBytesDownloaded(): MathExpression | Metric ``` ##### `metricTotalBytesUploaded` ```typescript public metricTotalBytesUploaded(): MathExpression | Metric ``` ##### `metricTotalErrorRateAverage` ```typescript public metricTotalErrorRateAverage(): MathExpression | Metric ``` ### CloudFrontDistributionMonitoring #### Initializers ```typescript import { CloudFrontDistributionMonitoring } from 'cdk-monitoring-constructs' new CloudFrontDistributionMonitoring(scope: MonitoringScope, props: CloudFrontDistributionMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | CloudFrontDistributionMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* CloudFrontDistributionMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createCacheWidget | *No description.* | | createErrorRateWidget | *No description.* | | createTitleWidget | *No description.* | | createTpsWidget | *No description.* | | createTrafficWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createCacheWidget` ```typescript public createCacheWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createErrorRateWidget` ```typescript public createErrorRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### `createTpsWidget` ```typescript public createTpsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTrafficWidget` ```typescript public createTrafficWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | additionalMetricsEnabled | boolean | *No description.* | | alarmFactory | AlarmFactory | *No description.* | | downloadedBytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | error4xxRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | error5xxRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | namingStrategy | MonitoringNamingStrategy | *No description.* | | title | string | *No description.* | | tpsAlarmFactory | TpsAlarmFactory | *No description.* | | tpsAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | tpsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | uploadedBytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cacheHitRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | distributionUrl | string | *No description.* | --- ##### `additionalMetricsEnabled`^Required ```typescript public readonly additionalMetricsEnabled: boolean; ``` - *Type:* boolean --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `downloadedBytesMetric`^Required ```typescript public readonly downloadedBytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `error4xxRate`^Required ```typescript public readonly error4xxRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `error5xxRate`^Required ```typescript public readonly error5xxRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `namingStrategy`^Required ```typescript public readonly namingStrategy: MonitoringNamingStrategy; ``` - *Type:* MonitoringNamingStrategy --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `tpsAlarmFactory`^Required ```typescript public readonly tpsAlarmFactory: TpsAlarmFactory; ``` - *Type:* TpsAlarmFactory --- ##### `tpsAnnotations`^Required ```typescript public readonly tpsAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `tpsMetric`^Required ```typescript public readonly tpsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `uploadedBytesMetric`^Required ```typescript public readonly uploadedBytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cacheHitRate`^Optional ```typescript public readonly cacheHitRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `distributionUrl`^Optional ```typescript public readonly distributionUrl: string; ``` - *Type:* string --- ### CloudWatchLogsMetricFactory #### Initializers ```typescript import { CloudWatchLogsMetricFactory } from 'cdk-monitoring-constructs' new CloudWatchLogsMetricFactory(metricFactory: MetricFactory, props: CloudWatchLogsMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | CloudWatchLogsMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* CloudWatchLogsMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricIncomingLogEvents | *No description.* | --- ##### `metricIncomingLogEvents` ```typescript public metricIncomingLogEvents(): MathExpression | Metric ``` ### CodeBuildProjectMetricFactory #### Initializers ```typescript import { CodeBuildProjectMetricFactory } from 'cdk-monitoring-constructs' new CodeBuildProjectMetricFactory(metricFactory: MetricFactory, props: CodeBuildProjectMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | CodeBuildProjectMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* CodeBuildProjectMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricBuildCount | *No description.* | | metricDurationP50InSeconds | *No description.* | | metricDurationP90InSeconds | *No description.* | | metricDurationP99InSeconds | *No description.* | | metricFailedBuildCount | *No description.* | | metricFailedBuildRate | *No description.* | | metricSucceededBuildCount | *No description.* | --- ##### `metricBuildCount` ```typescript public metricBuildCount(): MathExpression | Metric ``` ##### `metricDurationP50InSeconds` ```typescript public metricDurationP50InSeconds(): MathExpression | Metric ``` ##### `metricDurationP90InSeconds` ```typescript public metricDurationP90InSeconds(): MathExpression | Metric ``` ##### `metricDurationP99InSeconds` ```typescript public metricDurationP99InSeconds(): MathExpression | Metric ``` ##### `metricFailedBuildCount` ```typescript public metricFailedBuildCount(): MathExpression | Metric ``` ##### `metricFailedBuildRate` ```typescript public metricFailedBuildRate(): MathExpression | Metric ``` ##### `metricSucceededBuildCount` ```typescript public metricSucceededBuildCount(): MathExpression | Metric ``` ### CodeBuildProjectMonitoring #### Initializers ```typescript import { CodeBuildProjectMonitoring } from 'cdk-monitoring-constructs' new CodeBuildProjectMonitoring(scope: MonitoringScope, props: CodeBuildProjectMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | CodeBuildProjectMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* CodeBuildProjectMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createBuildCountsWidget | *No description.* | | createDurationWidget | *No description.* | | createFailedBuildRateWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createBuildCountsWidget` ```typescript public createBuildCountsWidget(): GraphWidget ``` ##### `createDurationWidget` ```typescript public createDurationWidget(): GraphWidget ``` ##### `createFailedBuildRateWidget` ```typescript public createFailedBuildRateWidget(): GraphWidget ``` ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | buildCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | durationAlarmFactory | LatencyAlarmFactory | *No description.* | | durationAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | durationP50InSecondsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | durationP90InSecondsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | durationP99InSecondsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | failedBuildCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | failedBuildRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | succeededBuildCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | projectUrl | string | *No description.* | --- ##### `buildCountMetric`^Required ```typescript public readonly buildCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `durationAlarmFactory`^Required ```typescript public readonly durationAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `durationAnnotations`^Required ```typescript public readonly durationAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `durationP50InSecondsMetric`^Required ```typescript public readonly durationP50InSecondsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `durationP90InSecondsMetric`^Required ```typescript public readonly durationP90InSecondsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `durationP99InSecondsMetric`^Required ```typescript public readonly durationP99InSecondsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `failedBuildCountMetric`^Required ```typescript public readonly failedBuildCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `failedBuildRateMetric`^Required ```typescript public readonly failedBuildRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `succeededBuildCountMetric`^Required ```typescript public readonly succeededBuildCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `projectUrl`^Optional ```typescript public readonly projectUrl: string; ``` - *Type:* string --- ### CompositeMetricAdjuster - *Implements:* IMetricAdjuster Allows to apply a collection of {@link IMetricAdjuster} to a metric. #### Initializers ```typescript import { CompositeMetricAdjuster } from 'cdk-monitoring-constructs' new CompositeMetricAdjuster(adjusters: IMetricAdjuster[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | adjusters | IMetricAdjuster[] | *No description.* | --- ##### `adjusters`^Required - *Type:* IMetricAdjuster[] --- #### Methods | **Name** | **Description** | | --- | --- | | adjustMetric | Adjusts a metric. | --- ##### `adjustMetric` ```typescript public adjustMetric(metric: MathExpression | Metric, alarmScope: Construct, props: AddAlarmProps): MathExpression | Metric ``` Adjusts a metric. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `alarmScope`^Required - *Type:* constructs.Construct --- ###### `props`^Required - *Type:* AddAlarmProps --- #### Static Functions | **Name** | **Description** | | --- | --- | | of | *No description.* | --- ##### `of` ```typescript import { CompositeMetricAdjuster } from 'cdk-monitoring-constructs' CompositeMetricAdjuster.of(adjusters: ...IMetricAdjuster[]) ``` ###### `adjusters`^Required - *Type:* ...IMetricAdjuster[] --- ### ConnectionAlarmFactory #### Initializers ```typescript import { ConnectionAlarmFactory } from 'cdk-monitoring-constructs' new ConnectionAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addMaxConnectionCountAlarm | *No description.* | | addMinConnectionCountAlarm | *No description.* | --- ##### `addMaxConnectionCountAlarm` ```typescript public addMaxConnectionCountAlarm(metric: MathExpression | Metric, props: HighConnectionCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* HighConnectionCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinConnectionCountAlarm` ```typescript public addMinConnectionCountAlarm(metric: MathExpression | Metric, props: LowConnectionCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* LowConnectionCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### CustomAlarmFactory #### Initializers ```typescript import { CustomAlarmFactory } from 'cdk-monitoring-constructs' new CustomAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addCustomAlarm | *No description.* | --- ##### `addCustomAlarm` ```typescript public addCustomAlarm(metric: MathExpression | Metric, alarmNameSuffix: string, disambiguator: string, props: CustomThreshold): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `alarmNameSuffix`^Required - *Type:* string --- ###### `disambiguator`^Required - *Type:* string --- ###### `props`^Required - *Type:* CustomThreshold --- ### CustomMonitoring Custom monitoring is a construct allowing you to monitor your own custom metrics. The entire construct consists of metric groups. Each metric group represents a single graph widget with multiple metrics. Each metric inside the metric group represents a single metric inside a graph. The widgets will be sized automatically to waste as little space as possible. #### Initializers ```typescript import { CustomMonitoring } from 'cdk-monitoring-constructs' new CustomMonitoring(scope: MonitoringScope, props: CustomMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | CustomMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* CustomMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | addToSummaryDashboard | boolean | *No description.* | | anomalyDetectingAlarmFactory | AnomalyDetectingAlarmFactory | *No description.* | | customAlarmFactory | CustomAlarmFactory | *No description.* | | metricGroups | CustomMetricGroupWithAnnotations[] | *No description.* | | title | string | *No description.* | | description | string | *No description.* | | descriptionWidgetHeight | number | *No description.* | | height | number | *No description.* | --- ##### `addToSummaryDashboard`^Required ```typescript public readonly addToSummaryDashboard: boolean; ``` - *Type:* boolean --- ##### `anomalyDetectingAlarmFactory`^Required ```typescript public readonly anomalyDetectingAlarmFactory: AnomalyDetectingAlarmFactory; ``` - *Type:* AnomalyDetectingAlarmFactory --- ##### `customAlarmFactory`^Required ```typescript public readonly customAlarmFactory: CustomAlarmFactory; ``` - *Type:* CustomAlarmFactory --- ##### `metricGroups`^Required ```typescript public readonly metricGroups: CustomMetricGroupWithAnnotations[]; ``` - *Type:* CustomMetricGroupWithAnnotations[] --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `description`^Optional ```typescript public readonly description: string; ``` - *Type:* string --- ##### `descriptionWidgetHeight`^Optional ```typescript public readonly descriptionWidgetHeight: number; ``` - *Type:* number --- ##### `height`^Optional ```typescript public readonly height: number; ``` - *Type:* number --- ### CustomWidget A dashboard widget that can be customized using a Lambda. #### Initializers ```typescript import { CustomWidget } from 'cdk-monitoring-constructs' new CustomWidget(props: CustomWidgetProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | CustomWidgetProps | *No description.* | --- ##### `props`^Required - *Type:* CustomWidgetProps --- #### Methods | **Name** | **Description** | | --- | --- | | position | Place the widget at a given position. | | toJson | Return the widget JSON for use in the dashboard. | --- ##### `position` ```typescript public position(x: number, y: number): void ``` Place the widget at a given position. ###### `x`^Required - *Type:* number --- ###### `y`^Required - *Type:* number --- ##### `toJson` ```typescript public toJson(): any[] ``` Return the widget JSON for use in the dashboard. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | height | number | The amount of vertical grid units the widget will take up. | | width | number | The amount of horizontal grid units the widget will take up. | | warnings | string[] | Any warnings that are produced as a result of putting together this widget. | | warningsV2 | {[ key: string ]: string} | Any warnings that are produced as a result of putting together this widget. | --- ##### `height`^Required ```typescript public readonly height: number; ``` - *Type:* number The amount of vertical grid units the widget will take up. --- ##### `width`^Required ```typescript public readonly width: number; ``` - *Type:* number The amount of horizontal grid units the widget will take up. --- ##### `warnings`^Optional ```typescript public readonly warnings: string[]; ``` - *Type:* string[] Any warnings that are produced as a result of putting together this widget. --- ##### `warningsV2`^Optional ```typescript public readonly warningsV2: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Any warnings that are produced as a result of putting together this widget. --- ### DefaultAlarmAnnotationStrategy Default annotation strategy that returns the built-in alarm annotation. #### Initializers ```typescript import { DefaultAlarmAnnotationStrategy } from 'cdk-monitoring-constructs' new DefaultAlarmAnnotationStrategy() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | createAnnotation | Creates annotation based on the metric and alarm properties. | --- ##### `createAnnotation` ```typescript public createAnnotation(props: AlarmAnnotationStrategyProps): HorizontalAnnotation ``` Creates annotation based on the metric and alarm properties. ###### `props`^Required - *Type:* AlarmAnnotationStrategyProps --- ### DefaultMetricAdjuster - *Implements:* IMetricAdjuster Applies the default metric adjustments. These adjustments are always applied last, regardless the value configured in {@link AddAlarmProps.metricAdjuster}. #### Initializers ```typescript import { DefaultMetricAdjuster } from 'cdk-monitoring-constructs' new DefaultMetricAdjuster() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | adjustMetric | Adjusts a metric. | --- ##### `adjustMetric` ```typescript public adjustMetric(metric: MathExpression | Metric, _: Construct, props: AddAlarmProps): MathExpression | Metric ``` Adjusts a metric. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `_`^Required - *Type:* constructs.Construct --- ###### `props`^Required - *Type:* AddAlarmProps --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | INSTANCE | DefaultMetricAdjuster | *No description.* | --- ##### `INSTANCE`^Required ```typescript public readonly INSTANCE: DefaultMetricAdjuster; ``` - *Type:* DefaultMetricAdjuster --- ### DefaultWidgetFactory - *Implements:* IWidgetFactory #### Initializers ```typescript import { DefaultWidgetFactory } from 'cdk-monitoring-constructs' new DefaultWidgetFactory() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | createAlarmDetailWidget | Create widget representing an alarm detail. | --- ##### `createAlarmDetailWidget` ```typescript public createAlarmDetailWidget(alarm: AlarmWithAnnotation): IWidget ``` Create widget representing an alarm detail. ###### `alarm`^Required - *Type:* AlarmWithAnnotation --- ### DocumentDbMetricFactory #### Initializers ```typescript import { DocumentDbMetricFactory } from 'cdk-monitoring-constructs' new DocumentDbMetricFactory(metricFactory: MetricFactory, props: DocumentDbMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | DocumentDbMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* DocumentDbMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAverageCpuUsageInPercent | *No description.* | | metricMaxConnectionCount | *No description.* | | metricMaxCursorCount | *No description.* | | metricMaxTransactionOpenCount | *No description.* | | metricOperationsThrottledDueLowMemoryCount | *No description.* | | metricReadLatencyInMillis | *No description.* | | metricWriteLatencyInMillis | *No description.* | --- ##### `metricAverageCpuUsageInPercent` ```typescript public metricAverageCpuUsageInPercent(): MathExpression | Metric ``` ##### `metricMaxConnectionCount` ```typescript public metricMaxConnectionCount(): MathExpression | Metric ``` ##### `metricMaxCursorCount` ```typescript public metricMaxCursorCount(): MathExpression | Metric ``` ##### `metricMaxTransactionOpenCount` ```typescript public metricMaxTransactionOpenCount(): MathExpression | Metric ``` ##### `metricOperationsThrottledDueLowMemoryCount` ```typescript public metricOperationsThrottledDueLowMemoryCount(): MathExpression | Metric ``` ##### `metricReadLatencyInMillis` ```typescript public metricReadLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricWriteLatencyInMillis` ```typescript public metricWriteLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterIdentifier | string | *No description.* | --- ##### `clusterIdentifier`^Required ```typescript public readonly clusterIdentifier: string; ``` - *Type:* string --- ### DocumentDbMonitoring #### Initializers ```typescript import { DocumentDbMonitoring } from 'cdk-monitoring-constructs' new DocumentDbMonitoring(scope: MonitoringScope, props: DocumentDbMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | DocumentDbMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* DocumentDbMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createConnectionsWidget | *No description.* | | createLatencyWidget | *No description.* | | createResourceUsageWidget | *No description.* | | createTitleWidget | *No description.* | | createTransactionsWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createConnectionsWidget` ```typescript public createConnectionsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createResourceUsageWidget` ```typescript public createResourceUsageWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### `createTransactionsWidget` ```typescript public createTransactionsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cursorsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | readLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | throttledMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | transactionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | usageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | writeLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | url | string | *No description.* | --- ##### `connectionsMetric`^Required ```typescript public readonly connectionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageMetric`^Required ```typescript public readonly cpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cursorsMetric`^Required ```typescript public readonly cursorsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `readLatencyMetric`^Required ```typescript public readonly readLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `throttledMetric`^Required ```typescript public readonly throttledMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `transactionsMetric`^Required ```typescript public readonly transactionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `usageAnnotations`^Required ```typescript public readonly usageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `writeLatencyMetric`^Required ```typescript public readonly writeLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string --- ### DoNotModifyDedupeString Default dedupe strategy - does not add any prefix nor suffix. #### Initializers ```typescript import { DoNotModifyDedupeString } from 'cdk-monitoring-constructs' new DoNotModifyDedupeString(prefix?: string, suffix?: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | prefix | string | *No description.* | | suffix | string | *No description.* | --- ##### `prefix`^Optional - *Type:* string --- ##### `suffix`^Optional - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | processDedupeString | Process the dedupe string which was auto-generated. | | processDedupeStringOverride | Process the dedupe string which was specified by the user as an override. | --- ##### `processDedupeString` ```typescript public processDedupeString(dedupeString: string): string ``` Process the dedupe string which was auto-generated. ###### `dedupeString`^Required - *Type:* string --- ##### `processDedupeStringOverride` ```typescript public processDedupeStringOverride(dedupeString: string): string ``` Process the dedupe string which was specified by the user as an override. ###### `dedupeString`^Required - *Type:* string --- ### DoubleAxisGraphWidget Line graph widget with both left and right axes. The purpose of this custom class is to make the properties more strict. It will avoid graphs with undefined axes and dimensions. #### Initializers ```typescript import { DoubleAxisGraphWidget } from 'cdk-monitoring-constructs' new DoubleAxisGraphWidget(props: DoubleAxisGraphWidgetProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | DoubleAxisGraphWidgetProps | *No description.* | --- ##### `props`^Required - *Type:* DoubleAxisGraphWidgetProps --- #### Methods | **Name** | **Description** | | --- | --- | | position | Place the widget at a given position. | | toJson | Return the widget JSON for use in the dashboard. | | addLeftMetric | Add another metric to the left Y axis of the GraphWidget. | | addRightMetric | Add another metric to the right Y axis of the GraphWidget. | --- ##### `position` ```typescript public position(x: number, y: number): void ``` Place the widget at a given position. ###### `x`^Required - *Type:* number --- ###### `y`^Required - *Type:* number --- ##### `toJson` ```typescript public toJson(): any[] ``` Return the widget JSON for use in the dashboard. ##### `addLeftMetric` ```typescript public addLeftMetric(metric: IMetric): void ``` Add another metric to the left Y axis of the GraphWidget. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric the metric to add. --- ##### `addRightMetric` ```typescript public addRightMetric(metric: IMetric): void ``` Add another metric to the right Y axis of the GraphWidget. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric the metric to add. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | height | number | The amount of vertical grid units the widget will take up. | | width | number | The amount of horizontal grid units the widget will take up. | | warnings | string[] | Any warnings that are produced as a result of putting together this widget. | | warningsV2 | {[ key: string ]: string} | Any warnings that are produced as a result of putting together this widget. | --- ##### `height`^Required ```typescript public readonly height: number; ``` - *Type:* number The amount of vertical grid units the widget will take up. --- ##### `width`^Required ```typescript public readonly width: number; ``` - *Type:* number The amount of horizontal grid units the widget will take up. --- ##### `warnings`^Optional ```typescript public readonly warnings: string[]; ``` - *Type:* string[] Any warnings that are produced as a result of putting together this widget. --- ##### `warningsV2`^Optional ```typescript public readonly warningsV2: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Any warnings that are produced as a result of putting together this widget. --- ### DynamoAlarmFactory #### Initializers ```typescript import { DynamoAlarmFactory } from 'cdk-monitoring-constructs' new DynamoAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addConsumedCapacityAlarm | *No description.* | | addThrottledEventsAlarm | *No description.* | --- ##### `addConsumedCapacityAlarm` ```typescript public addConsumedCapacityAlarm(metric: MathExpression | Metric, capacityType: CapacityType, props: ConsumedCapacityThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `capacityType`^Required - *Type:* CapacityType --- ###### `props`^Required - *Type:* ConsumedCapacityThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addThrottledEventsAlarm` ```typescript public addThrottledEventsAlarm(metric: MathExpression | Metric, capacityType: CapacityType, props: ThrottledEventsThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `capacityType`^Required - *Type:* CapacityType --- ###### `props`^Required - *Type:* ThrottledEventsThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### DynamoTableGlobalSecondaryIndexMetricFactory #### Initializers ```typescript import { DynamoTableGlobalSecondaryIndexMetricFactory } from 'cdk-monitoring-constructs' new DynamoTableGlobalSecondaryIndexMetricFactory(metricFactory: MetricFactory, props: DynamoTableGlobalSecondaryIndexMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | DynamoTableGlobalSecondaryIndexMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* DynamoTableGlobalSecondaryIndexMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricConsumedReadCapacityUnits | *No description.* | | metricConsumedWriteCapacityUnits | *No description.* | | metricIndexConsumedWriteUnitsMetric | *No description.* | | metricProvisionedReadCapacityUnits | *No description.* | | metricProvisionedWriteCapacityUnits | *No description.* | | metricThrottledIndexRequestCount | *No description.* | | metricThrottledReadRequestCount | *No description.* | | metricThrottledWriteRequestCount | *No description.* | --- ##### `metricConsumedReadCapacityUnits` ```typescript public metricConsumedReadCapacityUnits(): MathExpression | Metric ``` ##### `metricConsumedWriteCapacityUnits` ```typescript public metricConsumedWriteCapacityUnits(): MathExpression | Metric ``` ##### `metricIndexConsumedWriteUnitsMetric` ```typescript public metricIndexConsumedWriteUnitsMetric(): MathExpression | Metric ``` ##### `metricProvisionedReadCapacityUnits` ```typescript public metricProvisionedReadCapacityUnits(): MathExpression | Metric ``` ##### `metricProvisionedWriteCapacityUnits` ```typescript public metricProvisionedWriteCapacityUnits(): MathExpression | Metric ``` ##### `metricThrottledIndexRequestCount` ```typescript public metricThrottledIndexRequestCount(): MathExpression | Metric ``` ##### `metricThrottledReadRequestCount` ```typescript public metricThrottledReadRequestCount(): MathExpression | Metric ``` ##### `metricThrottledWriteRequestCount` ```typescript public metricThrottledWriteRequestCount(): MathExpression | Metric ``` ### DynamoTableGlobalSecondaryIndexMonitoring #### Initializers ```typescript import { DynamoTableGlobalSecondaryIndexMonitoring } from 'cdk-monitoring-constructs' new DynamoTableGlobalSecondaryIndexMonitoring(scope: MonitoringScope, props: DynamoTableGlobalSecondaryIndexMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | DynamoTableGlobalSecondaryIndexMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* DynamoTableGlobalSecondaryIndexMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ### DynamoTableMetricFactory #### Initializers ```typescript import { DynamoTableMetricFactory } from 'cdk-monitoring-constructs' new DynamoTableMetricFactory(metricFactory: MetricFactory, props: DynamoTableMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | DynamoTableMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* DynamoTableMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAverageSuccessfulRequestLatencyInMillis | *No description.* | | metricConsumedReadCapacityUnits | *No description.* | | metricConsumedWriteCapacityUnits | *No description.* | | metricProvisionedReadCapacityUnits | *No description.* | | metricProvisionedWriteCapacityUnits | *No description.* | | metricReadCapacityUtilizationPercentage | *No description.* | | metricSearchAverageSuccessfulRequestLatencyInMillis | *No description.* | | metricSystemErrorsCount | This represents the number of requests that resulted in a 500 (server error) error code. | | metricThrottledReadRequestCount | *No description.* | | metricThrottledWriteRequestCount | *No description.* | | metricTimeToLiveDeletedItemCount | *No description.* | | metricWriteCapacityUtilizationPercentage | *No description.* | --- ##### `metricAverageSuccessfulRequestLatencyInMillis` ```typescript public metricAverageSuccessfulRequestLatencyInMillis(operation: Operation): MathExpression | Metric ``` ###### `operation`^Required - *Type:* aws-cdk-lib.aws_dynamodb.Operation --- ##### `metricConsumedReadCapacityUnits` ```typescript public metricConsumedReadCapacityUnits(): MathExpression | Metric ``` ##### `metricConsumedWriteCapacityUnits` ```typescript public metricConsumedWriteCapacityUnits(): MathExpression | Metric ``` ##### `metricProvisionedReadCapacityUnits` ```typescript public metricProvisionedReadCapacityUnits(): MathExpression | Metric ``` ##### `metricProvisionedWriteCapacityUnits` ```typescript public metricProvisionedWriteCapacityUnits(): MathExpression | Metric ``` ##### `metricReadCapacityUtilizationPercentage` ```typescript public metricReadCapacityUtilizationPercentage(): MathExpression | Metric ``` ##### `metricSearchAverageSuccessfulRequestLatencyInMillis` ```typescript public metricSearchAverageSuccessfulRequestLatencyInMillis(): MathExpression ``` ##### `metricSystemErrorsCount` ```typescript public metricSystemErrorsCount(): MathExpression | Metric ``` This represents the number of requests that resulted in a 500 (server error) error code. It summarizes across the basic CRUD operations: GetItem, BatchGetItem, Scan, Query, GetRecords, PutItem, DeleteItem, UpdateItem, BatchWriteItem It’s usually equal to zero. ##### `metricThrottledReadRequestCount` ```typescript public metricThrottledReadRequestCount(): MathExpression | Metric ``` ##### `metricThrottledWriteRequestCount` ```typescript public metricThrottledWriteRequestCount(): MathExpression | Metric ``` ##### `metricTimeToLiveDeletedItemCount` ```typescript public metricTimeToLiveDeletedItemCount(): MathExpression | Metric ``` ##### `metricWriteCapacityUtilizationPercentage` ```typescript public metricWriteCapacityUtilizationPercentage(): MathExpression | Metric ``` ### DynamoTableMonitoring #### Initializers ```typescript import { DynamoTableMonitoring } from 'cdk-monitoring-constructs' new DynamoTableMonitoring(scope: MonitoringScope, props: DynamoTableMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | DynamoTableMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* DynamoTableMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createErrorsWidget | *No description.* | | createLatencyWidget | *No description.* | | createReadCapacityWidget | *No description.* | | createThrottlesWidget | *No description.* | | createTitleWidget | *No description.* | | createWriteCapacityWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createErrorsWidget` ```typescript public createErrorsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createReadCapacityWidget` ```typescript public createReadCapacityWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createThrottlesWidget` ```typescript public createThrottlesWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### `createWriteCapacityWidget` ```typescript public createWriteCapacityWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | averagePerOperationLatencyMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric} | *No description.* | | consumedReadUnitsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | consumedWriteUnitsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | dynamoCapacityAlarmFactory | DynamoAlarmFactory | *No description.* | | dynamoReadCapacityAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | dynamoWriteCapacityAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | latencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | latencyAverageSearchMetrics | aws-cdk-lib.aws_cloudwatch.IMetric | *No description.* | | provisionedReadUnitsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | provisionedWriteUnitsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | readCapacityUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | readThrottleCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | systemErrorMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | tableBillingMode | aws-cdk-lib.aws_dynamodb.BillingMode | *No description.* | | throttledEventsAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | timeToLiveDeletedItemCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | writeCapacityUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | writeThrottleCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | tableUrl | string | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `averagePerOperationLatencyMetrics`^Required ```typescript public readonly averagePerOperationLatencyMetrics: {[ key: string ]: MathExpression | Metric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric} --- ##### `consumedReadUnitsMetric`^Required ```typescript public readonly consumedReadUnitsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `consumedWriteUnitsMetric`^Required ```typescript public readonly consumedWriteUnitsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `dynamoCapacityAlarmFactory`^Required ```typescript public readonly dynamoCapacityAlarmFactory: DynamoAlarmFactory; ``` - *Type:* DynamoAlarmFactory --- ##### `dynamoReadCapacityAnnotations`^Required ```typescript public readonly dynamoReadCapacityAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `dynamoWriteCapacityAnnotations`^Required ```typescript public readonly dynamoWriteCapacityAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `latencyAnnotations`^Required ```typescript public readonly latencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `latencyAverageSearchMetrics`^Required ```typescript public readonly latencyAverageSearchMetrics: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric --- ##### `provisionedReadUnitsMetric`^Required ```typescript public readonly provisionedReadUnitsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `provisionedWriteUnitsMetric`^Required ```typescript public readonly provisionedWriteUnitsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `readCapacityUsageMetric`^Required ```typescript public readonly readCapacityUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `readThrottleCountMetric`^Required ```typescript public readonly readThrottleCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `systemErrorMetric`^Required ```typescript public readonly systemErrorMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `tableBillingMode`^Required ```typescript public readonly tableBillingMode: BillingMode; ``` - *Type:* aws-cdk-lib.aws_dynamodb.BillingMode --- ##### `throttledEventsAnnotations`^Required ```typescript public readonly throttledEventsAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `timeToLiveDeletedItemCountMetric`^Required ```typescript public readonly timeToLiveDeletedItemCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `writeCapacityUsageMetric`^Required ```typescript public readonly writeCapacityUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `writeThrottleCountMetric`^Required ```typescript public readonly writeThrottleCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `tableUrl`^Optional ```typescript public readonly tableUrl: string; ``` - *Type:* string --- ### EC2AlarmFactory #### Initializers ```typescript import { EC2AlarmFactory } from 'cdk-monitoring-constructs' new EC2AlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addNetworkInAlarm | *No description.* | | addNetworkOutAlarm | *No description.* | --- ##### `addNetworkInAlarm` ```typescript public addNetworkInAlarm(metric: MathExpression | Metric, props: NetworkInThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* NetworkInThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addNetworkOutAlarm` ```typescript public addNetworkOutAlarm(metric: MathExpression | Metric, props: NetworkOutThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* NetworkOutThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### EC2MetricFactory #### Initializers ```typescript import { EC2MetricFactory } from 'cdk-monitoring-constructs' new EC2MetricFactory(metricFactory: MetricFactory, props: EC2MetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | EC2MetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* EC2MetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAverageCpuUtilisationPercent | The percentage of allocated EC2 compute units that are currently in use on the instance. | | metricAverageDiskReadBytes | Bytes read from all instance store volumes available to the instance. | | metricAverageDiskReadOps | Completed read operations from all instance store volumes available to the instance in a specified period of time. | | metricAverageDiskWriteBytes | Bytes written to all instance store volumes available to the instance. | | metricAverageDiskWriteOps | Completed write operations to all instance store volumes available to the instance in a specified period of time. | | metricAverageNetworkInRateBytes | The number of bytes received on all network interfaces by the instance. | | metricAverageNetworkOutRateBytes | The number of bytes sent out on all network interfaces by the instance. | | metricSumNetworkInRateBytes | The number of bytes received on all network interfaces by the instance. | | metricSumNetworkOutRateBytes | The number of bytes sent out on all network interfaces by the instance. | --- ##### `metricAverageCpuUtilisationPercent` ```typescript public metricAverageCpuUtilisationPercent(): (MathExpression | Metric)[] ``` The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on a selected instance. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. ##### `metricAverageDiskReadBytes` ```typescript public metricAverageDiskReadBytes(): (MathExpression | Metric)[] ``` Bytes read from all instance store volumes available to the instance. This metric is used to determine the volume of the data the application reads from the hard disk of the instance. This can be used to determine the speed of the application. ##### `metricAverageDiskReadOps` ```typescript public metricAverageDiskReadOps(): (MathExpression | Metric)[] ``` Completed read operations from all instance store volumes available to the instance in a specified period of time. ##### `metricAverageDiskWriteBytes` ```typescript public metricAverageDiskWriteBytes(): (MathExpression | Metric)[] ``` Bytes written to all instance store volumes available to the instance. This metric is used to determine the volume of the data the application writes onto the hard disk of the instance. This can be used to determine the speed of the application. ##### `metricAverageDiskWriteOps` ```typescript public metricAverageDiskWriteOps(): (MathExpression | Metric)[] ``` Completed write operations to all instance store volumes available to the instance in a specified period of time. ##### `metricAverageNetworkInRateBytes` ```typescript public metricAverageNetworkInRateBytes(): (MathExpression | Metric)[] ``` The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to a single instance. ##### `metricAverageNetworkOutRateBytes` ```typescript public metricAverageNetworkOutRateBytes(): (MathExpression | Metric)[] ``` The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from a single instance. ##### `metricSumNetworkInRateBytes` ```typescript public metricSumNetworkInRateBytes(): (MathExpression | Metric)[] ``` The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to a single instance. ##### `metricSumNetworkOutRateBytes` ```typescript public metricSumNetworkOutRateBytes(): (MathExpression | Metric)[] ``` The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from a single instance. ### EC2Monitoring #### Initializers ```typescript import { EC2Monitoring } from 'cdk-monitoring-constructs' new EC2Monitoring(scope: MonitoringScope, props: EC2MonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | EC2MonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* EC2MonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createCpuWidget | *No description.* | | createDiskOpsWidget | *No description.* | | createDiskWidget | *No description.* | | createNetworkWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createCpuWidget` ```typescript public createCpuWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createDiskOpsWidget` ```typescript public createDiskOpsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createDiskWidget` ```typescript public createDiskWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createNetworkWidget` ```typescript public createNetworkWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cpuUtilisationMetrics | aws-cdk-lib.aws_cloudwatch.IMetric[] | *No description.* | | diskReadBytesMetrics | aws-cdk-lib.aws_cloudwatch.IMetric[] | *No description.* | | diskReadOpsMetrics | aws-cdk-lib.aws_cloudwatch.IMetric[] | *No description.* | | diskWriteBytesMetrics | aws-cdk-lib.aws_cloudwatch.IMetric[] | *No description.* | | diskWriteOpsMetrics | aws-cdk-lib.aws_cloudwatch.IMetric[] | *No description.* | | ec2AlarmFactory | EC2AlarmFactory | *No description.* | | family | string | *No description.* | | networkInMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric[] | *No description.* | | networkInSumLimitAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | networkInSumMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric[] | *No description.* | | networkOutMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric[] | *No description.* | | networkOutSumLimitAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | networkOutSumMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric[] | *No description.* | | title | string | *No description.* | --- ##### `cpuUtilisationMetrics`^Required ```typescript public readonly cpuUtilisationMetrics: IMetric[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric[] --- ##### `diskReadBytesMetrics`^Required ```typescript public readonly diskReadBytesMetrics: IMetric[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric[] --- ##### `diskReadOpsMetrics`^Required ```typescript public readonly diskReadOpsMetrics: IMetric[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric[] --- ##### `diskWriteBytesMetrics`^Required ```typescript public readonly diskWriteBytesMetrics: IMetric[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric[] --- ##### `diskWriteOpsMetrics`^Required ```typescript public readonly diskWriteOpsMetrics: IMetric[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric[] --- ##### `ec2AlarmFactory`^Required ```typescript public readonly ec2AlarmFactory: EC2AlarmFactory; ``` - *Type:* EC2AlarmFactory --- ##### `family`^Required ```typescript public readonly family: string; ``` - *Type:* string --- ##### `networkInMetrics`^Required ```typescript public readonly networkInMetrics: (MathExpression | Metric)[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric[] --- ##### `networkInSumLimitAnnotations`^Required ```typescript public readonly networkInSumLimitAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `networkInSumMetrics`^Required ```typescript public readonly networkInSumMetrics: (MathExpression | Metric)[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric[] --- ##### `networkOutMetrics`^Required ```typescript public readonly networkOutMetrics: (MathExpression | Metric)[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric[] --- ##### `networkOutSumLimitAnnotations`^Required ```typescript public readonly networkOutSumLimitAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `networkOutSumMetrics`^Required ```typescript public readonly networkOutSumMetrics: (MathExpression | Metric)[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric[] --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ### Ec2ServiceMonitoring #### Initializers ```typescript import { Ec2ServiceMonitoring } from 'cdk-monitoring-constructs' new Ec2ServiceMonitoring(scope: MonitoringScope, props: CustomEc2ServiceMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | CustomEc2ServiceMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* CustomEc2ServiceMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createCpuWidget | *No description.* | | createMemoryWidget | *No description.* | | createTaskHealthWidget | *No description.* | | createTcpFlowsWidget | *No description.* | | createTitleWidget | *No description.* | | createTpcFlowsWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createCpuWidget` ```typescript public createCpuWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMemoryWidget` ```typescript public createMemoryWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTaskHealthWidget` ```typescript public createTaskHealthWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTcpFlowsWidget` ```typescript public createTcpFlowsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### ~~`createTpcFlowsWidget`~~ ```typescript public createTpcFlowsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | baseServiceMetricFactory | BaseServiceMetricFactory | *No description.* | | cpuP100UtilisationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | cpuUtilisationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | ephemeralStorageUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | memoryP100UtilisationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | memoryUsageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | memoryUtilisationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricFactory | MetricFactory | *No description.* | | processedBytesAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | runningTaskCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | taskHealthAlarmFactory | TaskHealthAlarmFactory | *No description.* | | taskHealthAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | throughputAlarmFactory | ThroughputAlarmFactory | *No description.* | | title | string | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | activeTcpFlowCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | healthyTaskCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | healthyTaskPercentMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | loadBalancerMetricFactory | ILoadBalancerMetricFactory | *No description.* | | newTcpFlowCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | processedBytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | unhealthyRoutingFlowCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | unhealthyTaskCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | --- ##### `baseServiceMetricFactory`^Required ```typescript public readonly baseServiceMetricFactory: BaseServiceMetricFactory; ``` - *Type:* BaseServiceMetricFactory --- ##### `cpuP100UtilisationMetric`^Required ```typescript public readonly cpuP100UtilisationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageAnnotations`^Required ```typescript public readonly cpuUsageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `cpuUtilisationMetric`^Required ```typescript public readonly cpuUtilisationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `ephemeralStorageUsageMetric`^Required ```typescript public readonly ephemeralStorageUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `memoryP100UtilisationMetric`^Required ```typescript public readonly memoryP100UtilisationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `memoryUsageAnnotations`^Required ```typescript public readonly memoryUsageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `memoryUtilisationMetric`^Required ```typescript public readonly memoryUtilisationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricFactory`^Required ```typescript public readonly metricFactory: MetricFactory; ``` - *Type:* MetricFactory --- ##### `processedBytesAnnotations`^Required ```typescript public readonly processedBytesAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `runningTaskCountMetric`^Required ```typescript public readonly runningTaskCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `taskHealthAlarmFactory`^Required ```typescript public readonly taskHealthAlarmFactory: TaskHealthAlarmFactory; ``` - *Type:* TaskHealthAlarmFactory --- ##### `taskHealthAnnotations`^Required ```typescript public readonly taskHealthAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `throughputAlarmFactory`^Required ```typescript public readonly throughputAlarmFactory: ThroughputAlarmFactory; ``` - *Type:* ThroughputAlarmFactory --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `activeTcpFlowCountMetric`^Optional ```typescript public readonly activeTcpFlowCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `healthyTaskCountMetric`^Optional ```typescript public readonly healthyTaskCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `healthyTaskPercentMetric`^Optional ```typescript public readonly healthyTaskPercentMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `loadBalancerMetricFactory`^Optional ```typescript public readonly loadBalancerMetricFactory: ILoadBalancerMetricFactory; ``` - *Type:* ILoadBalancerMetricFactory --- ##### `newTcpFlowCountMetric`^Optional ```typescript public readonly newTcpFlowCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `processedBytesMetric`^Optional ```typescript public readonly processedBytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `unhealthyRoutingFlowCountMetric`^Optional ```typescript public readonly unhealthyRoutingFlowCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `unhealthyTaskCountMetric`^Optional ```typescript public readonly unhealthyTaskCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ### ElastiCacheAlarmFactory #### Initializers ```typescript import { ElastiCacheAlarmFactory } from 'cdk-monitoring-constructs' new ElastiCacheAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addMaxEvictedItemsCountAlarm | *No description.* | | addMaxItemsCountAlarm | *No description.* | | addMaxThrottleRateAlarm | *No description.* | | addMaxUsedSwapMemoryAlarm | *No description.* | | addMinFreeableMemoryAlarm | *No description.* | | addMinHitRateAlarm | *No description.* | --- ##### `addMaxEvictedItemsCountAlarm` ```typescript public addMaxEvictedItemsCountAlarm(metric: MathExpression | Metric, props: MaxItemsCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxItemsCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxItemsCountAlarm` ```typescript public addMaxItemsCountAlarm(metric: MathExpression | Metric, props: MaxItemsCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxItemsCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxThrottleRateAlarm` ```typescript public addMaxThrottleRateAlarm(metric: MathExpression | Metric, props: MaxThrottleRateThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxThrottleRateThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxUsedSwapMemoryAlarm` ```typescript public addMaxUsedSwapMemoryAlarm(metric: MathExpression | Metric, props: MaxUsedSwapMemoryThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxUsedSwapMemoryThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinFreeableMemoryAlarm` ```typescript public addMinFreeableMemoryAlarm(metric: MathExpression | Metric, props: MinFreeableMemoryThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinFreeableMemoryThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinHitRateAlarm` ```typescript public addMinHitRateAlarm(metric: MathExpression | Metric, props: MinHitRateThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinHitRateThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### ElastiCacheClusterMetricFactory > [https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheMetrics.html](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheMetrics.html) #### Initializers ```typescript import { ElastiCacheClusterMetricFactory } from 'cdk-monitoring-constructs' new ElastiCacheClusterMetricFactory(metricFactory: MetricFactory, props: ElastiCacheClusterMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | ElastiCacheClusterMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* ElastiCacheClusterMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAverageCachedItemsSizeInBytes | *No description.* | | metricAverageConnections | *No description.* | | metricAverageFreeableMemoryInBytes | *No description.* | | metricAverageSwapUsageInBytes | *No description.* | | metricAverageUnusedMemoryInBytes | *No description.* | | metricEvictions | *No description.* | | metricMaxCpuUtilizationInPercent | *No description.* | | metricMaxItemCount | *No description.* | | metricMaxRedisEngineCpuUtilizationInPercent | Because Redis is single-threaded, you can use this metric to analyze the load of the Redis process itself. | | metricNetworkBytesIn | *No description.* | | metricNetworkBytesOut | *No description.* | --- ##### `metricAverageCachedItemsSizeInBytes` ```typescript public metricAverageCachedItemsSizeInBytes(): MathExpression | Metric ``` ##### `metricAverageConnections` ```typescript public metricAverageConnections(): MathExpression | Metric ``` ##### `metricAverageFreeableMemoryInBytes` ```typescript public metricAverageFreeableMemoryInBytes(): MathExpression | Metric ``` ##### `metricAverageSwapUsageInBytes` ```typescript public metricAverageSwapUsageInBytes(): MathExpression | Metric ``` ##### `metricAverageUnusedMemoryInBytes` ```typescript public metricAverageUnusedMemoryInBytes(): MathExpression | Metric ``` ##### `metricEvictions` ```typescript public metricEvictions(): MathExpression | Metric ``` ##### `metricMaxCpuUtilizationInPercent` ```typescript public metricMaxCpuUtilizationInPercent(): MathExpression | Metric ``` ##### `metricMaxItemCount` ```typescript public metricMaxItemCount(): MathExpression | Metric ``` ##### `metricMaxRedisEngineCpuUtilizationInPercent` ```typescript public metricMaxRedisEngineCpuUtilizationInPercent(): MathExpression | Metric ``` Because Redis is single-threaded, you can use this metric to analyze the load of the Redis process itself. Note that you may want to monitor both Engine CPU Utilization as well as CPU Utilization as background processes can take up a significant portion of the CPU workload. This is especially important for hosts with 2 vCPUs or less. > [https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheMetrics.Redis.html](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheMetrics.Redis.html) ##### `metricNetworkBytesIn` ```typescript public metricNetworkBytesIn(): MathExpression | Metric ``` ##### `metricNetworkBytesOut` ```typescript public metricNetworkBytesOut(): MathExpression | Metric ``` ### ElastiCacheClusterMonitoring #### Initializers ```typescript import { ElastiCacheClusterMonitoring } from 'cdk-monitoring-constructs' new ElastiCacheClusterMonitoring(scope: MonitoringScope, props: ElastiCacheClusterMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | ElastiCacheClusterMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* ElastiCacheClusterMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createConnectionsWidget | *No description.* | | createCpuUsageWidget | *No description.* | | createItemCountWidget | *No description.* | | createMemoryUsageWidget | *No description.* | | createRedisEngineCpuUsageWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createConnectionsWidget` ```typescript public createConnectionsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createCpuUsageWidget` ```typescript public createCpuUsageWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createItemCountWidget` ```typescript public createItemCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMemoryUsageWidget` ```typescript public createMemoryUsageWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createRedisEngineCpuUsageWidget` ```typescript public createRedisEngineCpuUsageWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterType | ElastiCacheClusterType | *No description.* | | connectionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | cpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | elastiCacheAlarmFactory | ElastiCacheAlarmFactory | *No description.* | | evictedItemsCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | freeableMemoryMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | itemsCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | itemsCountMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | itemsEvictedMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | itemsMemoryMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | memoryUsageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | redisEngineCpuUsageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | redisEngineCpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | swapMemoryMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | unusedMemoryMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | clusterUrl | string | *No description.* | --- ##### `clusterType`^Required ```typescript public readonly clusterType: ElastiCacheClusterType; ``` - *Type:* ElastiCacheClusterType --- ##### `connectionsMetric`^Required ```typescript public readonly connectionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageAnnotations`^Required ```typescript public readonly cpuUsageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `cpuUsageMetric`^Required ```typescript public readonly cpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `elastiCacheAlarmFactory`^Required ```typescript public readonly elastiCacheAlarmFactory: ElastiCacheAlarmFactory; ``` - *Type:* ElastiCacheAlarmFactory --- ##### `evictedItemsCountAnnotations`^Required ```typescript public readonly evictedItemsCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `freeableMemoryMetric`^Required ```typescript public readonly freeableMemoryMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `itemsCountAnnotations`^Required ```typescript public readonly itemsCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `itemsCountMetrics`^Required ```typescript public readonly itemsCountMetrics: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `itemsEvictedMetrics`^Required ```typescript public readonly itemsEvictedMetrics: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `itemsMemoryMetric`^Required ```typescript public readonly itemsMemoryMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `memoryUsageAnnotations`^Required ```typescript public readonly memoryUsageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `redisEngineCpuUsageAnnotations`^Required ```typescript public readonly redisEngineCpuUsageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `redisEngineCpuUsageMetric`^Required ```typescript public readonly redisEngineCpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `swapMemoryMetric`^Required ```typescript public readonly swapMemoryMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `unusedMemoryMetric`^Required ```typescript public readonly unusedMemoryMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `clusterUrl`^Optional ```typescript public readonly clusterUrl: string; ``` - *Type:* string --- ### ElastiCacheServerlessMetricFactory > [https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/serverless-metrics-events-redis.html](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/serverless-metrics-events-redis.html) #### Initializers ```typescript import { ElastiCacheServerlessMetricFactory } from 'cdk-monitoring-constructs' new ElastiCacheServerlessMetricFactory(metricFactory: MetricFactory, props: ElastiCacheServerlessMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | ElastiCacheServerlessMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* ElastiCacheServerlessMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAverageCacheHitRate | *No description.* | | metricAverageCacheSize | *No description.* | | metricAverageConnections | *No description.* | | metricCacheHits | *No description.* | | metricCacheMisses | *No description.* | | metricEvictions | *No description.* | | metricMaxElastiCacheProcessingUnits | *No description.* | | metricMaxItemCount | *No description.* | | metricNetworkBytesIn | *No description.* | | metricNetworkBytesOut | *No description.* | | metricSuccessfulReadRequestLatency | *No description.* | | metricSuccessfulWriteRequestLatency | *No description.* | | metricThrottleRate | *No description.* | | metricTotalCmds | *No description.* | | metricTotalThrottledCmds | *No description.* | --- ##### `metricAverageCacheHitRate` ```typescript public metricAverageCacheHitRate(): MathExpression | Metric ``` ##### `metricAverageCacheSize` ```typescript public metricAverageCacheSize(): MathExpression | Metric ``` ##### `metricAverageConnections` ```typescript public metricAverageConnections(): MathExpression | Metric ``` ##### `metricCacheHits` ```typescript public metricCacheHits(): MathExpression | Metric ``` ##### `metricCacheMisses` ```typescript public metricCacheMisses(): MathExpression | Metric ``` ##### `metricEvictions` ```typescript public metricEvictions(): MathExpression | Metric ``` ##### `metricMaxElastiCacheProcessingUnits` ```typescript public metricMaxElastiCacheProcessingUnits(): MathExpression | Metric ``` ##### `metricMaxItemCount` ```typescript public metricMaxItemCount(): MathExpression | Metric ``` ##### `metricNetworkBytesIn` ```typescript public metricNetworkBytesIn(): MathExpression | Metric ``` ##### `metricNetworkBytesOut` ```typescript public metricNetworkBytesOut(): MathExpression | Metric ``` ##### `metricSuccessfulReadRequestLatency` ```typescript public metricSuccessfulReadRequestLatency(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricSuccessfulWriteRequestLatency` ```typescript public metricSuccessfulWriteRequestLatency(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricThrottleRate` ```typescript public metricThrottleRate(): MathExpression | Metric ``` ##### `metricTotalCmds` ```typescript public metricTotalCmds(): MathExpression | Metric ``` ##### `metricTotalThrottledCmds` ```typescript public metricTotalThrottledCmds(): MathExpression | Metric ``` ### ElastiCacheServerlessMonitoring #### Initializers ```typescript import { ElastiCacheServerlessMonitoring } from 'cdk-monitoring-constructs' new ElastiCacheServerlessMonitoring(scope: MonitoringScope, props: ElastiCacheServerlessMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | ElastiCacheServerlessMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* ElastiCacheServerlessMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createCacheCmdsWidget | *No description.* | | createCacheHitAndMissWidget | *No description.* | | createCacheSizeWidget | *No description.* | | createConnectionsWidget | *No description.* | | createItemCountWidget | *No description.* | | createNetworkWidget | *No description.* | | createProcessingUnitsWidget | *No description.* | | createSuccessfulReadLatencyWidget | *No description.* | | createSuccessfulWriteLatencyWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createCacheCmdsWidget` ```typescript public createCacheCmdsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createCacheHitAndMissWidget` ```typescript public createCacheHitAndMissWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createCacheSizeWidget` ```typescript public createCacheSizeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createConnectionsWidget` ```typescript public createConnectionsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createItemCountWidget` ```typescript public createItemCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createNetworkWidget` ```typescript public createNetworkWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createProcessingUnitsWidget` ```typescript public createProcessingUnitsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createSuccessfulReadLatencyWidget` ```typescript public createSuccessfulReadLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createSuccessfulWriteLatencyWidget` ```typescript public createSuccessfulWriteLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | averageSuccessfulReadRequestLatencyAlarmAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | averageSuccessfulWriteRequestLatencyAlarmAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | elastiCacheAlarmFactory | ElastiCacheAlarmFactory | *No description.* | | hitRateAlarmAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | metricAverageCacheHitRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricAverageCacheSize | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricAverageConnections | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricAverageSuccessfulReadRequestLatency | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricAverageSuccessfulWriteRequestLatency | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricCacheHits | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricCacheMisses | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricEvictions | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricMaxElastiCacheProcessingUnits | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricMaxItemCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricNetworkBytesIn | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricNetworkBytesOut | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricThrottleRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricTM99SuccessfulReadRequestLatency | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricTM99SuccessfulWriteRequestLatency | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricTotalCmds | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricTotalThrottledCmds | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | throttleRateAlarmAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | title | string | *No description.* | | tm99SuccessfulReadRequestLatencyAlarmAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | tm99SuccessfulWriteRequestLatencyAlarmAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | --- ##### `averageSuccessfulReadRequestLatencyAlarmAnnotations`^Required ```typescript public readonly averageSuccessfulReadRequestLatencyAlarmAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `averageSuccessfulWriteRequestLatencyAlarmAnnotations`^Required ```typescript public readonly averageSuccessfulWriteRequestLatencyAlarmAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `elastiCacheAlarmFactory`^Required ```typescript public readonly elastiCacheAlarmFactory: ElastiCacheAlarmFactory; ``` - *Type:* ElastiCacheAlarmFactory --- ##### `hitRateAlarmAnnotations`^Required ```typescript public readonly hitRateAlarmAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `metricAverageCacheHitRate`^Required ```typescript public readonly metricAverageCacheHitRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricAverageCacheSize`^Required ```typescript public readonly metricAverageCacheSize: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricAverageConnections`^Required ```typescript public readonly metricAverageConnections: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricAverageSuccessfulReadRequestLatency`^Required ```typescript public readonly metricAverageSuccessfulReadRequestLatency: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricAverageSuccessfulWriteRequestLatency`^Required ```typescript public readonly metricAverageSuccessfulWriteRequestLatency: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricCacheHits`^Required ```typescript public readonly metricCacheHits: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricCacheMisses`^Required ```typescript public readonly metricCacheMisses: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricEvictions`^Required ```typescript public readonly metricEvictions: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricMaxElastiCacheProcessingUnits`^Required ```typescript public readonly metricMaxElastiCacheProcessingUnits: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricMaxItemCount`^Required ```typescript public readonly metricMaxItemCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricNetworkBytesIn`^Required ```typescript public readonly metricNetworkBytesIn: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricNetworkBytesOut`^Required ```typescript public readonly metricNetworkBytesOut: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricThrottleRate`^Required ```typescript public readonly metricThrottleRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricTM99SuccessfulReadRequestLatency`^Required ```typescript public readonly metricTM99SuccessfulReadRequestLatency: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricTM99SuccessfulWriteRequestLatency`^Required ```typescript public readonly metricTM99SuccessfulWriteRequestLatency: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricTotalCmds`^Required ```typescript public readonly metricTotalCmds: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricTotalThrottledCmds`^Required ```typescript public readonly metricTotalThrottledCmds: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `throttleRateAlarmAnnotations`^Required ```typescript public readonly throttleRateAlarmAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `tm99SuccessfulReadRequestLatencyAlarmAnnotations`^Required ```typescript public readonly tm99SuccessfulReadRequestLatencyAlarmAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `tm99SuccessfulWriteRequestLatencyAlarmAnnotations`^Required ```typescript public readonly tm99SuccessfulWriteRequestLatencyAlarmAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ### ErrorAlarmFactory #### Initializers ```typescript import { ErrorAlarmFactory } from 'cdk-monitoring-constructs' new ErrorAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addErrorCountAlarm | *No description.* | | addErrorRateAlarm | *No description.* | --- ##### `addErrorCountAlarm` ```typescript public addErrorCountAlarm(metric: MathExpression | Metric, errorType: string, props: ErrorCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `errorType`^Required - *Type:* string --- ###### `props`^Required - *Type:* ErrorCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addErrorRateAlarm` ```typescript public addErrorRateAlarm(metric: MathExpression | Metric, errorType: string, props: ErrorRateThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `errorType`^Required - *Type:* string --- ###### `props`^Required - *Type:* ErrorRateThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### ExtendDedupeString - *Implements:* IAlarmDedupeStringProcessor Dedupe string processor that adds prefix and/or suffix to the dedupe string. #### Initializers ```typescript import { ExtendDedupeString } from 'cdk-monitoring-constructs' new ExtendDedupeString(prefix?: string, suffix?: string) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | prefix | string | *No description.* | | suffix | string | *No description.* | --- ##### `prefix`^Optional - *Type:* string --- ##### `suffix`^Optional - *Type:* string --- #### Methods | **Name** | **Description** | | --- | --- | | processDedupeString | Process the dedupe string which was auto-generated. | | processDedupeStringOverride | Process the dedupe string which was specified by the user as an override. | --- ##### `processDedupeString` ```typescript public processDedupeString(dedupeString: string): string ``` Process the dedupe string which was auto-generated. ###### `dedupeString`^Required - *Type:* string --- ##### `processDedupeStringOverride` ```typescript public processDedupeStringOverride(dedupeString: string): string ``` Process the dedupe string which was specified by the user as an override. ###### `dedupeString`^Required - *Type:* string --- ### FargateServiceMonitoring #### Initializers ```typescript import { FargateServiceMonitoring } from 'cdk-monitoring-constructs' new FargateServiceMonitoring(scope: MonitoringScope, props: CustomFargateServiceMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | CustomFargateServiceMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* CustomFargateServiceMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createCpuWidget | *No description.* | | createMemoryWidget | *No description.* | | createTaskHealthWidget | *No description.* | | createTcpFlowsWidget | *No description.* | | createTitleWidget | *No description.* | | createTpcFlowsWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createCpuWidget` ```typescript public createCpuWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMemoryWidget` ```typescript public createMemoryWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTaskHealthWidget` ```typescript public createTaskHealthWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTcpFlowsWidget` ```typescript public createTcpFlowsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### ~~`createTpcFlowsWidget`~~ ```typescript public createTpcFlowsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | baseServiceMetricFactory | BaseServiceMetricFactory | *No description.* | | cpuP100UtilisationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | cpuUtilisationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | ephemeralStorageUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | memoryP100UtilisationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | memoryUsageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | memoryUtilisationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricFactory | MetricFactory | *No description.* | | processedBytesAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | runningTaskCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | taskHealthAlarmFactory | TaskHealthAlarmFactory | *No description.* | | taskHealthAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | throughputAlarmFactory | ThroughputAlarmFactory | *No description.* | | title | string | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | activeTcpFlowCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | healthyTaskCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | healthyTaskPercentMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | loadBalancerMetricFactory | ILoadBalancerMetricFactory | *No description.* | | newTcpFlowCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | processedBytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | unhealthyRoutingFlowCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | unhealthyTaskCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | --- ##### `baseServiceMetricFactory`^Required ```typescript public readonly baseServiceMetricFactory: BaseServiceMetricFactory; ``` - *Type:* BaseServiceMetricFactory --- ##### `cpuP100UtilisationMetric`^Required ```typescript public readonly cpuP100UtilisationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageAnnotations`^Required ```typescript public readonly cpuUsageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `cpuUtilisationMetric`^Required ```typescript public readonly cpuUtilisationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `ephemeralStorageUsageMetric`^Required ```typescript public readonly ephemeralStorageUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `memoryP100UtilisationMetric`^Required ```typescript public readonly memoryP100UtilisationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `memoryUsageAnnotations`^Required ```typescript public readonly memoryUsageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `memoryUtilisationMetric`^Required ```typescript public readonly memoryUtilisationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricFactory`^Required ```typescript public readonly metricFactory: MetricFactory; ``` - *Type:* MetricFactory --- ##### `processedBytesAnnotations`^Required ```typescript public readonly processedBytesAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `runningTaskCountMetric`^Required ```typescript public readonly runningTaskCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `taskHealthAlarmFactory`^Required ```typescript public readonly taskHealthAlarmFactory: TaskHealthAlarmFactory; ``` - *Type:* TaskHealthAlarmFactory --- ##### `taskHealthAnnotations`^Required ```typescript public readonly taskHealthAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `throughputAlarmFactory`^Required ```typescript public readonly throughputAlarmFactory: ThroughputAlarmFactory; ``` - *Type:* ThroughputAlarmFactory --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `activeTcpFlowCountMetric`^Optional ```typescript public readonly activeTcpFlowCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `healthyTaskCountMetric`^Optional ```typescript public readonly healthyTaskCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `healthyTaskPercentMetric`^Optional ```typescript public readonly healthyTaskPercentMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `loadBalancerMetricFactory`^Optional ```typescript public readonly loadBalancerMetricFactory: ILoadBalancerMetricFactory; ``` - *Type:* ILoadBalancerMetricFactory --- ##### `newTcpFlowCountMetric`^Optional ```typescript public readonly newTcpFlowCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `processedBytesMetric`^Optional ```typescript public readonly processedBytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `unhealthyRoutingFlowCountMetric`^Optional ```typescript public readonly unhealthyRoutingFlowCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `unhealthyTaskCountMetric`^Optional ```typescript public readonly unhealthyTaskCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ### FillingAlarmAnnotationStrategy - *Implements:* IAlarmAnnotationStrategy Annotation strategy that fills the annotation provided, using the input and user requirements. #### Initializers ```typescript import { FillingAlarmAnnotationStrategy } from 'cdk-monitoring-constructs' new FillingAlarmAnnotationStrategy() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | createAnnotation | Creates annotation based on the metric and alarm properties. | --- ##### `createAnnotation` ```typescript public createAnnotation(props: AlarmAnnotationStrategyProps): HorizontalAnnotation ``` Creates annotation based on the metric and alarm properties. ###### `props`^Required - *Type:* AlarmAnnotationStrategyProps --- ### FluentBitMetricFactory #### Initializers ```typescript import { FluentBitMetricFactory } from 'cdk-monitoring-constructs' new FluentBitMetricFactory(scope: MonitoringScope, props: FluentBitMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | FluentBitMetricFactoryProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* FluentBitMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | filterMetrics | *No description.* | | inputMetrics | *No description.* | | metricsWithoutWidgets | *No description.* | | outputMetrics | *No description.* | | storageMetrics | *No description.* | --- ##### `filterMetrics` ```typescript public filterMetrics(logGroup: ILogGroup): Metric[] ``` ###### `logGroup`^Required - *Type:* aws-cdk-lib.aws_logs.ILogGroup --- ##### `inputMetrics` ```typescript public inputMetrics(logGroup: ILogGroup): Metric[] ``` ###### `logGroup`^Required - *Type:* aws-cdk-lib.aws_logs.ILogGroup --- ##### `metricsWithoutWidgets` ```typescript public metricsWithoutWidgets(logGroup: ILogGroup): void ``` ###### `logGroup`^Required - *Type:* aws-cdk-lib.aws_logs.ILogGroup --- ##### `outputMetrics` ```typescript public outputMetrics(logGroup: ILogGroup): Metric[] ``` ###### `logGroup`^Required - *Type:* aws-cdk-lib.aws_logs.ILogGroup --- ##### `storageMetrics` ```typescript public storageMetrics(logGroup: ILogGroup): Metric[] ``` ###### `logGroup`^Required - *Type:* aws-cdk-lib.aws_logs.ILogGroup --- ### FluentBitMonitoring #### Initializers ```typescript import { FluentBitMonitoring } from 'cdk-monitoring-constructs' new FluentBitMonitoring(scope: MonitoringScope, props: FluentBitMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | FluentBitMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* FluentBitMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ### GlueJobMetricFactory #### Initializers ```typescript import { GlueJobMetricFactory } from 'cdk-monitoring-constructs' new GlueJobMetricFactory(metricFactory: MetricFactory, props: GlueJobMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | GlueJobMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* GlueJobMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricActiveExecutorsAverage | *No description.* | | metricAverageExecutorCpuUsagePercentage | *No description.* | | metricAverageExecutorMemoryUsagePercentage | *No description.* | | metricCompletedStagesSum | *No description.* | | metricCompletedTasksSum | *No description.* | | metricFailedTasksRate | *No description.* | | metricFailedTasksSum | *No description.* | | metricKilledTasksRate | *No description.* | | metricKilledTasksSum | *No description.* | | metricMaximumNeededExecutors | *No description.* | | metricTotalReadBytesFromS3 | *No description.* | | metricTotalWrittenBytesToS3 | *No description.* | --- ##### `metricActiveExecutorsAverage` ```typescript public metricActiveExecutorsAverage(): MathExpression | Metric ``` ##### `metricAverageExecutorCpuUsagePercentage` ```typescript public metricAverageExecutorCpuUsagePercentage(): MathExpression | Metric ``` ##### `metricAverageExecutorMemoryUsagePercentage` ```typescript public metricAverageExecutorMemoryUsagePercentage(): MathExpression | Metric ``` ##### `metricCompletedStagesSum` ```typescript public metricCompletedStagesSum(): MathExpression | Metric ``` ##### `metricCompletedTasksSum` ```typescript public metricCompletedTasksSum(): MathExpression | Metric ``` ##### `metricFailedTasksRate` ```typescript public metricFailedTasksRate(): MathExpression | Metric ``` ##### `metricFailedTasksSum` ```typescript public metricFailedTasksSum(): MathExpression | Metric ``` ##### `metricKilledTasksRate` ```typescript public metricKilledTasksRate(): MathExpression | Metric ``` ##### `metricKilledTasksSum` ```typescript public metricKilledTasksSum(): MathExpression | Metric ``` ##### `metricMaximumNeededExecutors` ```typescript public metricMaximumNeededExecutors(): MathExpression | Metric ``` ##### `metricTotalReadBytesFromS3` ```typescript public metricTotalReadBytesFromS3(): MathExpression | Metric ``` ##### `metricTotalWrittenBytesToS3` ```typescript public metricTotalWrittenBytesToS3(): MathExpression | Metric ``` ### GlueJobMonitoring #### Initializers ```typescript import { GlueJobMonitoring } from 'cdk-monitoring-constructs' new GlueJobMonitoring(scope: MonitoringScope, props: GlueJobMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | GlueJobMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* GlueJobMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createDataMovementWidget | *No description.* | | createErrorCountWidget | *No description.* | | createErrorRateWidget | *No description.* | | createJobExecutionWidget | *No description.* | | createTitleWidget | *No description.* | | createUtilizationWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createDataMovementWidget` ```typescript public createDataMovementWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createErrorCountWidget` ```typescript public createErrorCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createErrorRateWidget` ```typescript public createErrorRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createJobExecutionWidget` ```typescript public createJobExecutionWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### `createUtilizationWidget` ```typescript public createUtilizationWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | activeExecutorsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | alarmFactory | AlarmFactory | *No description.* | | bytesReadFromS3Metric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | bytesWrittenToS3Metric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | completedStagesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | failedTaskCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | failedTaskRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | heapMemoryUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | killedTaskCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | killedTaskRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | neededExecutorsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | --- ##### `activeExecutorsMetric`^Required ```typescript public readonly activeExecutorsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `bytesReadFromS3Metric`^Required ```typescript public readonly bytesReadFromS3Metric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `bytesWrittenToS3Metric`^Required ```typescript public readonly bytesWrittenToS3Metric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `completedStagesMetric`^Required ```typescript public readonly completedStagesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageMetric`^Required ```typescript public readonly cpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `failedTaskCountMetric`^Required ```typescript public readonly failedTaskCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `failedTaskRateMetric`^Required ```typescript public readonly failedTaskRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `heapMemoryUsageMetric`^Required ```typescript public readonly heapMemoryUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `killedTaskCountMetric`^Required ```typescript public readonly killedTaskCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `killedTaskRateMetric`^Required ```typescript public readonly killedTaskRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `neededExecutorsMetric`^Required ```typescript public readonly neededExecutorsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ### HeaderWidget #### Initializers ```typescript import { HeaderWidget } from 'cdk-monitoring-constructs' new HeaderWidget(text: string, level?: HeaderLevel, description?: string, descriptionHeight?: number) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | text | string | *No description.* | | level | HeaderLevel | *No description.* | | description | string | *No description.* | | descriptionHeight | number | *No description.* | --- ##### `text`^Required - *Type:* string --- ##### `level`^Optional - *Type:* HeaderLevel --- ##### `description`^Optional - *Type:* string --- ##### `descriptionHeight`^Optional - *Type:* number --- #### Methods | **Name** | **Description** | | --- | --- | | position | Place the widget at a given position. | | toJson | Return the widget JSON for use in the dashboard. | --- ##### `position` ```typescript public position(x: number, y: number): void ``` Place the widget at a given position. ###### `x`^Required - *Type:* number --- ###### `y`^Required - *Type:* number --- ##### `toJson` ```typescript public toJson(): any[] ``` Return the widget JSON for use in the dashboard. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | height | number | The amount of vertical grid units the widget will take up. | | width | number | The amount of horizontal grid units the widget will take up. | | warnings | string[] | Any warnings that are produced as a result of putting together this widget. | | warningsV2 | {[ key: string ]: string} | Any warnings that are produced as a result of putting together this widget. | --- ##### `height`^Required ```typescript public readonly height: number; ``` - *Type:* number The amount of vertical grid units the widget will take up. --- ##### `width`^Required ```typescript public readonly width: number; ``` - *Type:* number The amount of horizontal grid units the widget will take up. --- ##### `warnings`^Optional ```typescript public readonly warnings: string[]; ``` - *Type:* string[] Any warnings that are produced as a result of putting together this widget. --- ##### `warningsV2`^Optional ```typescript public readonly warningsV2: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Any warnings that are produced as a result of putting together this widget. --- ### KeyValueTableWidget A widget that displays key-value pairs in a table format. #### Initializers ```typescript import { KeyValueTableWidget } from 'cdk-monitoring-constructs' new KeyValueTableWidget(data: KeyValue[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | data | KeyValue[] | An array of key-value pairs as objects. | --- ##### `data`^Required - *Type:* KeyValue[] An array of key-value pairs as objects. --- #### Methods | **Name** | **Description** | | --- | --- | | position | Place the widget at a given position. | | toJson | Return the widget JSON for use in the dashboard. | --- ##### `position` ```typescript public position(x: number, y: number): void ``` Place the widget at a given position. ###### `x`^Required - *Type:* number --- ###### `y`^Required - *Type:* number --- ##### `toJson` ```typescript public toJson(): any[] ``` Return the widget JSON for use in the dashboard. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | height | number | The amount of vertical grid units the widget will take up. | | width | number | The amount of horizontal grid units the widget will take up. | | warnings | string[] | Any warnings that are produced as a result of putting together this widget. | | warningsV2 | {[ key: string ]: string} | Any warnings that are produced as a result of putting together this widget. | --- ##### `height`^Required ```typescript public readonly height: number; ``` - *Type:* number The amount of vertical grid units the widget will take up. --- ##### `width`^Required ```typescript public readonly width: number; ``` - *Type:* number The amount of horizontal grid units the widget will take up. --- ##### `warnings`^Optional ```typescript public readonly warnings: string[]; ``` - *Type:* string[] Any warnings that are produced as a result of putting together this widget. --- ##### `warningsV2`^Optional ```typescript public readonly warningsV2: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Any warnings that are produced as a result of putting together this widget. --- ### KinesisAlarmFactory #### Initializers ```typescript import { KinesisAlarmFactory } from 'cdk-monitoring-constructs' new KinesisAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addConsumerIteratorMaxAgeAlarm | *No description.* | | addConsumerSubscribeToShardRateExceededAlarm | *No description.* | | addConsumerSubscribeToShardSuccessAlarm | *No description.* | | addFirehoseStreamExceedSafetyThresholdAlarm | *No description.* | | addIteratorMaxAgeAlarm | *No description.* | | addProvisionedReadThroughputExceededAlarm | *No description.* | | addProvisionedWriteThroughputExceededAlarm | *No description.* | | addPutRecordsFailedAlarm | *No description.* | | addPutRecordsThrottledAlarm | *No description.* | --- ##### `addConsumerIteratorMaxAgeAlarm` ```typescript public addConsumerIteratorMaxAgeAlarm(metric: MathExpression | Metric, props: MaxIteratorAgeThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxIteratorAgeThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addConsumerSubscribeToShardRateExceededAlarm` ```typescript public addConsumerSubscribeToShardRateExceededAlarm(metric: MathExpression | Metric, props: ConsumerRateExceededThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* ConsumerRateExceededThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addConsumerSubscribeToShardSuccessAlarm` ```typescript public addConsumerSubscribeToShardSuccessAlarm(metric: MathExpression | Metric, props: MinConsumerSubscribeToShardSuccessThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinConsumerSubscribeToShardSuccessThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addFirehoseStreamExceedSafetyThresholdAlarm` ```typescript public addFirehoseStreamExceedSafetyThresholdAlarm(metric: MathExpression | Metric, metricName: string, quotaName: string, props: FirehoseStreamLimitThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `metricName`^Required - *Type:* string --- ###### `quotaName`^Required - *Type:* string --- ###### `props`^Required - *Type:* FirehoseStreamLimitThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addIteratorMaxAgeAlarm` ```typescript public addIteratorMaxAgeAlarm(metric: MathExpression | Metric, props: MaxIteratorAgeThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxIteratorAgeThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addProvisionedReadThroughputExceededAlarm` ```typescript public addProvisionedReadThroughputExceededAlarm(metric: MathExpression | Metric, props: RecordsThrottledThreshold, disambiguator: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* RecordsThrottledThreshold --- ###### `disambiguator`^Required - *Type:* string --- ##### `addProvisionedWriteThroughputExceededAlarm` ```typescript public addProvisionedWriteThroughputExceededAlarm(metric: MathExpression | Metric, props: RecordsThrottledThreshold, disambiguator: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* RecordsThrottledThreshold --- ###### `disambiguator`^Required - *Type:* string --- ##### `addPutRecordsFailedAlarm` ```typescript public addPutRecordsFailedAlarm(metric: MathExpression | Metric, props: RecordsFailedThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* RecordsFailedThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addPutRecordsThrottledAlarm` ```typescript public addPutRecordsThrottledAlarm(metric: MathExpression | Metric, props: RecordsThrottledThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* RecordsThrottledThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### KinesisDataAnalyticsAlarmFactory #### Initializers ```typescript import { KinesisDataAnalyticsAlarmFactory } from 'cdk-monitoring-constructs' new KinesisDataAnalyticsAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addBackPressuredTimeMsPerSecondAlarm | *No description.* | | addCheckpointFailureCountAlarm | *No description.* | | addCheckpointFailureRateAlarm | *No description.* | | addDowntimeAlarm | *No description.* | | addFullRestartAlarm | *No description.* | | addFullRestartRateAlarm | *No description.* | --- ##### `addBackPressuredTimeMsPerSecondAlarm` ```typescript public addBackPressuredTimeMsPerSecondAlarm(metric: MathExpression | Metric, props: MaxBackPressuredTimeMsPerSecondThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxBackPressuredTimeMsPerSecondThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addCheckpointFailureCountAlarm` ```typescript public addCheckpointFailureCountAlarm(metric: MathExpression | Metric, props: ErrorCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* ErrorCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addCheckpointFailureRateAlarm` ```typescript public addCheckpointFailureRateAlarm(metric: MathExpression | Metric, props: ErrorRateThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* ErrorRateThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addDowntimeAlarm` ```typescript public addDowntimeAlarm(metric: MathExpression | Metric, props: MaxDowntimeThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxDowntimeThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addFullRestartAlarm` ```typescript public addFullRestartAlarm(metric: MathExpression | Metric, props: FullRestartCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* FullRestartCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addFullRestartRateAlarm` ```typescript public addFullRestartRateAlarm(metric: MathExpression | Metric, props: ErrorRateThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* ErrorRateThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### KinesisDataAnalyticsMetricFactory > [https://docs.aws.amazon.com/kinesisanalytics/latest/java/metrics-dimensions.html](https://docs.aws.amazon.com/kinesisanalytics/latest/java/metrics-dimensions.html) #### Initializers ```typescript import { KinesisDataAnalyticsMetricFactory } from 'cdk-monitoring-constructs' new KinesisDataAnalyticsMetricFactory(metricFactory: MetricFactory, props: KinesisDataAnalyticsMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | KinesisDataAnalyticsMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* KinesisDataAnalyticsMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricBackPressuredTimeMsPerSecond | *No description.* | | metricCheckpointFailureRate | *No description.* | | metricCpuUtilizationPercent | *No description.* | | metricDowntimeMs | *No description.* | | metricFullRestartRate | *No description.* | | metricFullRestartsCount | *No description.* | | metricHeapMemoryUtilizationPercent | *No description.* | | metricKPUsCount | *No description.* | | metricLastCheckpointDurationMs | *No description.* | | metricLastCheckpointSizeBytes | *No description.* | | metricNumberOfFailedCheckpointsCount | *No description.* | | metricOldGenerationGCCount | *No description.* | | metricOldGenerationGCTimeMs | *No description.* | | metricUptimeMs | *No description.* | --- ##### `metricBackPressuredTimeMsPerSecond` ```typescript public metricBackPressuredTimeMsPerSecond(): MathExpression | Metric ``` ##### `metricCheckpointFailureRate` ```typescript public metricCheckpointFailureRate(): MathExpression | Metric ``` ##### `metricCpuUtilizationPercent` ```typescript public metricCpuUtilizationPercent(): MathExpression | Metric ``` ##### `metricDowntimeMs` ```typescript public metricDowntimeMs(): MathExpression | Metric ``` ##### `metricFullRestartRate` ```typescript public metricFullRestartRate(): MathExpression | Metric ``` ##### `metricFullRestartsCount` ```typescript public metricFullRestartsCount(): MathExpression | Metric ``` ##### `metricHeapMemoryUtilizationPercent` ```typescript public metricHeapMemoryUtilizationPercent(): MathExpression | Metric ``` ##### `metricKPUsCount` ```typescript public metricKPUsCount(): MathExpression | Metric ``` ##### `metricLastCheckpointDurationMs` ```typescript public metricLastCheckpointDurationMs(): MathExpression | Metric ``` ##### `metricLastCheckpointSizeBytes` ```typescript public metricLastCheckpointSizeBytes(): MathExpression | Metric ``` ##### `metricNumberOfFailedCheckpointsCount` ```typescript public metricNumberOfFailedCheckpointsCount(): MathExpression | Metric ``` ##### `metricOldGenerationGCCount` ```typescript public metricOldGenerationGCCount(): MathExpression | Metric ``` ##### `metricOldGenerationGCTimeMs` ```typescript public metricOldGenerationGCTimeMs(): MathExpression | Metric ``` ##### `metricUptimeMs` ```typescript public metricUptimeMs(): MathExpression | Metric ``` ### KinesisDataAnalyticsMonitoring #### Initializers ```typescript import { KinesisDataAnalyticsMonitoring } from 'cdk-monitoring-constructs' new KinesisDataAnalyticsMonitoring(scope: MonitoringScope, props: KinesisDataAnalyticsMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | KinesisDataAnalyticsMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* KinesisDataAnalyticsMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createBackPressuredTimeWidget | *No description.* | | createDownTimeWidget | *No description.* | | createFullRestartsWidget | *No description.* | | createGarbageCollectionWidget | *No description.* | | createKPUWidget | *No description.* | | createLastCheckpointDurationWidget | *No description.* | | createLastCheckpointSizeWidget | *No description.* | | createNumberOfFailedCheckpointsWidget | *No description.* | | createResourceUtilizationWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createBackPressuredTimeWidget` ```typescript public createBackPressuredTimeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createDownTimeWidget` ```typescript public createDownTimeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createFullRestartsWidget` ```typescript public createFullRestartsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createGarbageCollectionWidget` ```typescript public createGarbageCollectionWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createKPUWidget` ```typescript public createKPUWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLastCheckpointDurationWidget` ```typescript public createLastCheckpointDurationWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLastCheckpointSizeWidget` ```typescript public createLastCheckpointSizeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createNumberOfFailedCheckpointsWidget` ```typescript public createNumberOfFailedCheckpointsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createResourceUtilizationWidget` ```typescript public createResourceUtilizationWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | backPressuredTimeMsPerSecondAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | backPressuredTimeMsPerSecondMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | checkpointFailureCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | checkpointFailureRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | checkpointFailureRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUtilizationPercentMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | downtimeAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | downtimeMsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | fullRestartAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | fullRestartRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | fullRestartRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | fullRestartsCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | heapMemoryUtilizationPercentMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | kdaAlarmFactory | KinesisDataAnalyticsAlarmFactory | *No description.* | | kpusCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | lastCheckpointDurationMsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | lastCheckpointSizeBytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | numberOfFailedCheckpointsCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | oldGenerationGCCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | oldGenerationGCTimeMsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | kinesisDataAnalyticsUrl | string | *No description.* | --- ##### `backPressuredTimeMsPerSecondAnnotations`^Required ```typescript public readonly backPressuredTimeMsPerSecondAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `backPressuredTimeMsPerSecondMetric`^Required ```typescript public readonly backPressuredTimeMsPerSecondMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `checkpointFailureCountAnnotations`^Required ```typescript public readonly checkpointFailureCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `checkpointFailureRateAnnotations`^Required ```typescript public readonly checkpointFailureRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `checkpointFailureRateMetric`^Required ```typescript public readonly checkpointFailureRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUtilizationPercentMetric`^Required ```typescript public readonly cpuUtilizationPercentMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `downtimeAnnotations`^Required ```typescript public readonly downtimeAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `downtimeMsMetric`^Required ```typescript public readonly downtimeMsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `fullRestartAnnotations`^Required ```typescript public readonly fullRestartAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `fullRestartRateAnnotations`^Required ```typescript public readonly fullRestartRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `fullRestartRateMetric`^Required ```typescript public readonly fullRestartRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `fullRestartsCountMetric`^Required ```typescript public readonly fullRestartsCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `heapMemoryUtilizationPercentMetric`^Required ```typescript public readonly heapMemoryUtilizationPercentMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `kdaAlarmFactory`^Required ```typescript public readonly kdaAlarmFactory: KinesisDataAnalyticsAlarmFactory; ``` - *Type:* KinesisDataAnalyticsAlarmFactory --- ##### `kpusCountMetric`^Required ```typescript public readonly kpusCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `lastCheckpointDurationMsMetric`^Required ```typescript public readonly lastCheckpointDurationMsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `lastCheckpointSizeBytesMetric`^Required ```typescript public readonly lastCheckpointSizeBytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `numberOfFailedCheckpointsCountMetric`^Required ```typescript public readonly numberOfFailedCheckpointsCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `oldGenerationGCCountMetric`^Required ```typescript public readonly oldGenerationGCCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `oldGenerationGCTimeMsMetric`^Required ```typescript public readonly oldGenerationGCTimeMsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `kinesisDataAnalyticsUrl`^Optional ```typescript public readonly kinesisDataAnalyticsUrl: string; ``` - *Type:* string --- ### KinesisDataStreamConsumerMetricFactory Metrics for a single enhanced fan-out (EFO) consumer of a Kinesis data stream. Dimensions: {StreamName, ConsumerName}. > [https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html#kinesis-metrics-consumer](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html#kinesis-metrics-consumer) #### Initializers ```typescript import { KinesisDataStreamConsumerMetricFactory } from 'cdk-monitoring-constructs' new KinesisDataStreamConsumerMetricFactory(metricFactory: MetricFactory, props: KinesisDataStreamConsumerMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | KinesisDataStreamConsumerMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* KinesisDataStreamConsumerMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricSubscribeToShardEventMillisBehindLatestMaxMs | Max lag (ms) for events delivered to this EFO consumer. | | metricSubscribeToShardEventRecordsSumCount | Records delivered to this consumer. | | metricSubscribeToShardEventSuccessAverage | Success rate of individual SubscribeToShardEvent deliveries within an open subscription. | | metricSubscribeToShardEventSumBytes | Bytes delivered to this consumer. | | metricSubscribeToShardRateExceededAverage | Rate at which SubscribeToShard calls for this consumer are throttled. | | metricSubscribeToShardSuccessAverage | Success rate of SubscribeToShard calls (connect handshake). | --- ##### `metricSubscribeToShardEventMillisBehindLatestMaxMs` ```typescript public metricSubscribeToShardEventMillisBehindLatestMaxMs(): MathExpression | Metric ``` Max lag (ms) for events delivered to this EFO consumer. ##### `metricSubscribeToShardEventRecordsSumCount` ```typescript public metricSubscribeToShardEventRecordsSumCount(): MathExpression | Metric ``` Records delivered to this consumer. ##### `metricSubscribeToShardEventSuccessAverage` ```typescript public metricSubscribeToShardEventSuccessAverage(): MathExpression | Metric ``` Success rate of individual SubscribeToShardEvent deliveries within an open subscription. ##### `metricSubscribeToShardEventSumBytes` ```typescript public metricSubscribeToShardEventSumBytes(): MathExpression | Metric ``` Bytes delivered to this consumer. ##### `metricSubscribeToShardRateExceededAverage` ```typescript public metricSubscribeToShardRateExceededAverage(): MathExpression | Metric ``` Rate at which SubscribeToShard calls for this consumer are throttled. ##### `metricSubscribeToShardSuccessAverage` ```typescript public metricSubscribeToShardSuccessAverage(): MathExpression | Metric ``` Success rate of SubscribeToShard calls (connect handshake). ### KinesisDataStreamConsumerMonitoring #### Initializers ```typescript import { KinesisDataStreamConsumerMonitoring } from 'cdk-monitoring-constructs' new KinesisDataStreamConsumerMonitoring(scope: MonitoringScope, props: KinesisDataStreamConsumerMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | KinesisDataStreamConsumerMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* KinesisDataStreamConsumerMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createBytesWidget | *No description.* | | createMillisBehindLatestWidget | *No description.* | | createRateExceededWidget | *No description.* | | createRecordsWidget | *No description.* | | createSubscribeSuccessWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createBytesWidget` ```typescript public createBytesWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMillisBehindLatestWidget` ```typescript public createMillisBehindLatestWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createRateExceededWidget` ```typescript public createRateExceededWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createRecordsWidget` ```typescript public createRecordsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createSubscribeSuccessWidget` ```typescript public createSubscribeSuccessWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | bytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | kinesisAlarmFactory | KinesisAlarmFactory | *No description.* | | millisBehindLatestMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | rateExceededAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | rateExceededMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | recordsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | subscribeSuccessAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | subscribeToShardEventSuccessMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | subscribeToShardSuccessMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | streamUrl | string | *No description.* | --- ##### `ageAnnotations`^Required ```typescript public readonly ageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `bytesMetric`^Required ```typescript public readonly bytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `kinesisAlarmFactory`^Required ```typescript public readonly kinesisAlarmFactory: KinesisAlarmFactory; ``` - *Type:* KinesisAlarmFactory --- ##### `millisBehindLatestMetric`^Required ```typescript public readonly millisBehindLatestMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `rateExceededAnnotations`^Required ```typescript public readonly rateExceededAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `rateExceededMetric`^Required ```typescript public readonly rateExceededMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `recordsMetric`^Required ```typescript public readonly recordsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `subscribeSuccessAnnotations`^Required ```typescript public readonly subscribeSuccessAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `subscribeToShardEventSuccessMetric`^Required ```typescript public readonly subscribeToShardEventSuccessMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `subscribeToShardSuccessMetric`^Required ```typescript public readonly subscribeToShardSuccessMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `streamUrl`^Optional ```typescript public readonly streamUrl: string; ``` - *Type:* string --- ### KinesisDataStreamMetricFactory > [https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html) #### Initializers ```typescript import { KinesisDataStreamMetricFactory } from 'cdk-monitoring-constructs' new KinesisDataStreamMetricFactory(metricFactory: MetricFactory, props: KinesisDataStreamMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | KinesisDataStreamMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* KinesisDataStreamMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricGetRecordsIteratorAgeMaxMs | *No description.* | | metricGetRecordsLatencyAverageMs | *No description.* | | metricGetRecordsSuccessCount | *No description.* | | metricGetRecordsSumBytes | *No description.* | | metricGetRecordsSumCount | *No description.* | | metricIncomingDataSumBytes | *No description.* | | metricIncomingDataSumCount | *No description.* | | metricPutRecordLatencyAverageMs | *No description.* | | metricPutRecordsFailedRecordsCount | *No description.* | | metricPutRecordsLatencyAverageMs | *No description.* | | metricPutRecordsSuccessCount | *No description.* | | metricPutRecordsSuccessfulRecordsCount | *No description.* | | metricPutRecordsSumBytes | *No description.* | | metricPutRecordsThrottledRecordsCount | *No description.* | | metricPutRecordsTotalRecordsCount | *No description.* | | metricPutRecordSuccessCount | *No description.* | | metricPutRecordSumBytes | *No description.* | | metricReadProvisionedThroughputExceeded | *No description.* | | metricReadProvisionedThroughputExceededPercent | *No description.* | | metricWriteProvisionedThroughputExceeded | *No description.* | | metricWriteProvisionedThroughputExceededPercent | *No description.* | --- ##### `metricGetRecordsIteratorAgeMaxMs` ```typescript public metricGetRecordsIteratorAgeMaxMs(): MathExpression | Metric ``` ##### `metricGetRecordsLatencyAverageMs` ```typescript public metricGetRecordsLatencyAverageMs(): MathExpression | Metric ``` ##### `metricGetRecordsSuccessCount` ```typescript public metricGetRecordsSuccessCount(): MathExpression | Metric ``` ##### `metricGetRecordsSumBytes` ```typescript public metricGetRecordsSumBytes(): MathExpression | Metric ``` ##### `metricGetRecordsSumCount` ```typescript public metricGetRecordsSumCount(): MathExpression | Metric ``` ##### `metricIncomingDataSumBytes` ```typescript public metricIncomingDataSumBytes(): MathExpression | Metric ``` ##### `metricIncomingDataSumCount` ```typescript public metricIncomingDataSumCount(): MathExpression | Metric ``` ##### `metricPutRecordLatencyAverageMs` ```typescript public metricPutRecordLatencyAverageMs(): MathExpression | Metric ``` ##### `metricPutRecordsFailedRecordsCount` ```typescript public metricPutRecordsFailedRecordsCount(): MathExpression | Metric ``` ##### `metricPutRecordsLatencyAverageMs` ```typescript public metricPutRecordsLatencyAverageMs(): MathExpression | Metric ``` ##### `metricPutRecordsSuccessCount` ```typescript public metricPutRecordsSuccessCount(): MathExpression | Metric ``` ##### `metricPutRecordsSuccessfulRecordsCount` ```typescript public metricPutRecordsSuccessfulRecordsCount(): MathExpression | Metric ``` ##### `metricPutRecordsSumBytes` ```typescript public metricPutRecordsSumBytes(): MathExpression | Metric ``` ##### `metricPutRecordsThrottledRecordsCount` ```typescript public metricPutRecordsThrottledRecordsCount(): MathExpression | Metric ``` ##### `metricPutRecordsTotalRecordsCount` ```typescript public metricPutRecordsTotalRecordsCount(): MathExpression | Metric ``` ##### `metricPutRecordSuccessCount` ```typescript public metricPutRecordSuccessCount(): MathExpression | Metric ``` ##### `metricPutRecordSumBytes` ```typescript public metricPutRecordSumBytes(): MathExpression | Metric ``` ##### `metricReadProvisionedThroughputExceeded` ```typescript public metricReadProvisionedThroughputExceeded(): MathExpression | Metric ``` ##### ~~`metricReadProvisionedThroughputExceededPercent`~~ ```typescript public metricReadProvisionedThroughputExceededPercent(): MathExpression | Metric ``` ##### `metricWriteProvisionedThroughputExceeded` ```typescript public metricWriteProvisionedThroughputExceeded(): MathExpression | Metric ``` ##### ~~`metricWriteProvisionedThroughputExceededPercent`~~ ```typescript public metricWriteProvisionedThroughputExceededPercent(): MathExpression | Metric ``` ### KinesisDataStreamMonitoring #### Initializers ```typescript import { KinesisDataStreamMonitoring } from 'cdk-monitoring-constructs' new KinesisDataStreamMonitoring(scope: MonitoringScope, props: KinesisDataStreamMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | KinesisDataStreamMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* KinesisDataStreamMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createCapacityWidget | *No description.* | | createIncomingDataWidget | *No description.* | | createIteratorAgeWidget | *No description.* | | createLatencyWidget | *No description.* | | createOperationWidget | *No description.* | | createRecordNumberWidget | *No description.* | | createRecordSizeWidget | *No description.* | | createSecondAdditionalRow | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createCapacityWidget` ```typescript public createCapacityWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createIncomingDataWidget` ```typescript public createIncomingDataWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createIteratorAgeWidget` ```typescript public createIteratorAgeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createOperationWidget` ```typescript public createOperationWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createRecordNumberWidget` ```typescript public createRecordNumberWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createRecordSizeWidget` ```typescript public createRecordSizeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createSecondAdditionalRow` ```typescript public createSecondAdditionalRow(): Row ``` ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | incomingDataSumBytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | incomingDataSumCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | kinesisAlarmFactory | KinesisAlarmFactory | *No description.* | | metricGetRecordsIteratorAge | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricGetRecordsLatencyAverage | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricGetRecordsSuccessCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricGetRecordsSumCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricGetRecordSumBytes | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | provisionedCapacityAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | putRecordLatencyAverageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordsFailedRecordsCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordsLatencyAverageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordsSuccessCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordsSuccessfulRecordsCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordsSumBytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordsThrottledRecordsCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordsTotalRecordsCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordSuccessCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordSumBytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | readProvisionedThroughputExceededMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | recordCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | title | string | *No description.* | | writeProvisionedThroughputExceededMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | streamUrl | string | *No description.* | --- ##### `ageAnnotations`^Required ```typescript public readonly ageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `incomingDataSumBytesMetric`^Required ```typescript public readonly incomingDataSumBytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `incomingDataSumCountMetric`^Required ```typescript public readonly incomingDataSumCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `kinesisAlarmFactory`^Required ```typescript public readonly kinesisAlarmFactory: KinesisAlarmFactory; ``` - *Type:* KinesisAlarmFactory --- ##### `metricGetRecordsIteratorAge`^Required ```typescript public readonly metricGetRecordsIteratorAge: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricGetRecordsLatencyAverage`^Required ```typescript public readonly metricGetRecordsLatencyAverage: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricGetRecordsSuccessCount`^Required ```typescript public readonly metricGetRecordsSuccessCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricGetRecordsSumCount`^Required ```typescript public readonly metricGetRecordsSumCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricGetRecordSumBytes`^Required ```typescript public readonly metricGetRecordSumBytes: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `provisionedCapacityAnnotations`^Required ```typescript public readonly provisionedCapacityAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `putRecordLatencyAverageMetric`^Required ```typescript public readonly putRecordLatencyAverageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordsFailedRecordsCountMetric`^Required ```typescript public readonly putRecordsFailedRecordsCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordsLatencyAverageMetric`^Required ```typescript public readonly putRecordsLatencyAverageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordsSuccessCountMetric`^Required ```typescript public readonly putRecordsSuccessCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordsSuccessfulRecordsCountMetric`^Required ```typescript public readonly putRecordsSuccessfulRecordsCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordsSumBytesMetric`^Required ```typescript public readonly putRecordsSumBytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordsThrottledRecordsCountMetric`^Required ```typescript public readonly putRecordsThrottledRecordsCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordsTotalRecordsCountMetric`^Required ```typescript public readonly putRecordsTotalRecordsCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordSuccessCountMetric`^Required ```typescript public readonly putRecordSuccessCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordSumBytesMetric`^Required ```typescript public readonly putRecordSumBytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `readProvisionedThroughputExceededMetric`^Required ```typescript public readonly readProvisionedThroughputExceededMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `recordCountAnnotations`^Required ```typescript public readonly recordCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `writeProvisionedThroughputExceededMetric`^Required ```typescript public readonly writeProvisionedThroughputExceededMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `streamUrl`^Optional ```typescript public readonly streamUrl: string; ``` - *Type:* string --- ### KinesisFirehoseMetricFactory > [https://docs.aws.amazon.com/firehose/latest/dev/monitoring-with-cloudwatch-metrics.html](https://docs.aws.amazon.com/firehose/latest/dev/monitoring-with-cloudwatch-metrics.html) #### Initializers ```typescript import { KinesisFirehoseMetricFactory } from 'cdk-monitoring-constructs' new KinesisFirehoseMetricFactory(metricFactory: MetricFactory, props: KinesisFirehoseMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | KinesisFirehoseMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* KinesisFirehoseMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricBytesPerSecondLimit | *No description.* | | metricFailedConversionCount | *No description.* | | metricIncomingBytes | *No description.* | | metricIncomingBytesToLimitRate | *No description.* | | metricIncomingPutRequests | *No description.* | | metricIncomingPutRequestsToLimitRate | *No description.* | | metricIncomingRecordCount | *No description.* | | metricIncomingRecordsToLimitRate | *No description.* | | metricPutRecordBatchLatencyP90InMillis | *No description.* | | metricPutRecordLatencyP90InMillis | *No description.* | | metricPutRequestsPerSecondLimit | *No description.* | | metricRecordsPerSecondLimit | *No description.* | | metricSuccessfulConversionCount | *No description.* | | metricThrottledRecordCount | *No description.* | --- ##### `metricBytesPerSecondLimit` ```typescript public metricBytesPerSecondLimit(): MathExpression | Metric ``` ##### `metricFailedConversionCount` ```typescript public metricFailedConversionCount(): MathExpression | Metric ``` ##### `metricIncomingBytes` ```typescript public metricIncomingBytes(): MathExpression | Metric ``` ##### `metricIncomingBytesToLimitRate` ```typescript public metricIncomingBytesToLimitRate(): MathExpression | Metric ``` ##### `metricIncomingPutRequests` ```typescript public metricIncomingPutRequests(): MathExpression | Metric ``` ##### `metricIncomingPutRequestsToLimitRate` ```typescript public metricIncomingPutRequestsToLimitRate(): MathExpression | Metric ``` ##### `metricIncomingRecordCount` ```typescript public metricIncomingRecordCount(): MathExpression | Metric ``` ##### `metricIncomingRecordsToLimitRate` ```typescript public metricIncomingRecordsToLimitRate(): MathExpression | Metric ``` ##### `metricPutRecordBatchLatencyP90InMillis` ```typescript public metricPutRecordBatchLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricPutRecordLatencyP90InMillis` ```typescript public metricPutRecordLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricPutRequestsPerSecondLimit` ```typescript public metricPutRequestsPerSecondLimit(): MathExpression | Metric ``` ##### `metricRecordsPerSecondLimit` ```typescript public metricRecordsPerSecondLimit(): MathExpression | Metric ``` ##### `metricSuccessfulConversionCount` ```typescript public metricSuccessfulConversionCount(): MathExpression | Metric ``` ##### `metricThrottledRecordCount` ```typescript public metricThrottledRecordCount(): MathExpression | Metric ``` ### KinesisFirehoseMonitoring #### Initializers ```typescript import { KinesisFirehoseMonitoring } from 'cdk-monitoring-constructs' new KinesisFirehoseMonitoring(scope: MonitoringScope, props: KinesisFirehoseMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | KinesisFirehoseMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* KinesisFirehoseMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createConversionWidget | *No description.* | | createIncomingRecordWidget | *No description.* | | createLatencyWidget | *No description.* | | createLimitWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createConversionWidget` ```typescript public createConversionWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createIncomingRecordWidget` ```typescript public createIncomingRecordWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLimitWidget` ```typescript public createLimitWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | failedConversionMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | incomingBytesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | incomingBytesToLimitRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | incomingLimitAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | incomingPutRequestsToLimitRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | incomingRecordsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | incomingRecordsToLimitRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | isDataFormatConversionEnabled | boolean | *No description.* | | kinesisAlarmFactory | KinesisAlarmFactory | *No description.* | | putRecordBatchLatency | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | putRecordLatency | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | recordCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | successfulConversionMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | throttledRecordsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | streamUrl | string | *No description.* | --- ##### `failedConversionMetric`^Required ```typescript public readonly failedConversionMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `incomingBytesMetric`^Required ```typescript public readonly incomingBytesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `incomingBytesToLimitRate`^Required ```typescript public readonly incomingBytesToLimitRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `incomingLimitAnnotations`^Required ```typescript public readonly incomingLimitAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `incomingPutRequestsToLimitRate`^Required ```typescript public readonly incomingPutRequestsToLimitRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `incomingRecordsMetric`^Required ```typescript public readonly incomingRecordsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `incomingRecordsToLimitRate`^Required ```typescript public readonly incomingRecordsToLimitRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `isDataFormatConversionEnabled`^Required ```typescript public readonly isDataFormatConversionEnabled: boolean; ``` - *Type:* boolean --- ##### `kinesisAlarmFactory`^Required ```typescript public readonly kinesisAlarmFactory: KinesisAlarmFactory; ``` - *Type:* KinesisAlarmFactory --- ##### `putRecordBatchLatency`^Required ```typescript public readonly putRecordBatchLatency: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `putRecordLatency`^Required ```typescript public readonly putRecordLatency: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `recordCountAnnotations`^Required ```typescript public readonly recordCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `successfulConversionMetric`^Required ```typescript public readonly successfulConversionMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `throttledRecordsMetric`^Required ```typescript public readonly throttledRecordsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `streamUrl`^Optional ```typescript public readonly streamUrl: string; ``` - *Type:* string --- ### LambdaAlarmActionStrategy - *Implements:* IAlarmActionStrategy Alarm action strategy that triggers a Lambda function. #### Initializers ```typescript import { LambdaAlarmActionStrategy } from 'cdk-monitoring-constructs' new LambdaAlarmActionStrategy(lambdaFunction: IAlias | IFunction | IVersion) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | lambdaFunction | aws-cdk-lib.aws_lambda.IAlias \| aws-cdk-lib.aws_lambda.IFunction \| aws-cdk-lib.aws_lambda.IVersion | *No description.* | --- ##### `lambdaFunction`^Required - *Type:* aws-cdk-lib.aws_lambda.IAlias | aws-cdk-lib.aws_lambda.IFunction | aws-cdk-lib.aws_lambda.IVersion --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarmActions | *No description.* | --- ##### `addAlarmActions` ```typescript public addAlarmActions(props: AlarmActionStrategyProps): void ``` ###### `props`^Required - *Type:* AlarmActionStrategyProps --- ### LambdaFunctionEnhancedMetricFactory #### Initializers ```typescript import { LambdaFunctionEnhancedMetricFactory } from 'cdk-monitoring-constructs' new LambdaFunctionEnhancedMetricFactory(metricFactory: MetricFactory, props: LambdaFunctionEnhancedMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | LambdaFunctionEnhancedMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* LambdaFunctionEnhancedMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | enhancedMetricAvgCpuTotalTime | *No description.* | | enhancedMetricAvgInitDuration | *No description.* | | enhancedMetricAvgMemoryUtilization | *No description.* | | enhancedMetricFunctionCost | *No description.* | | enhancedMetricInitDuration | *No description.* | | enhancedMetricMaxCpuTotalTime | *No description.* | | enhancedMetricMaxInitDuration | *No description.* | | enhancedMetricMaxMemoryUtilization | *No description.* | | enhancedMetricMaxTotalMemory | *No description.* | | enhancedMetricP90CpuTotalTime | *No description.* | | enhancedMetricP90InitDuration | *No description.* | | enhancedMetricP90MemoryUtilization | *No description.* | --- ##### `enhancedMetricAvgCpuTotalTime` ```typescript public enhancedMetricAvgCpuTotalTime(): MathExpression | Metric ``` ##### `enhancedMetricAvgInitDuration` ```typescript public enhancedMetricAvgInitDuration(): MathExpression | Metric ``` ##### `enhancedMetricAvgMemoryUtilization` ```typescript public enhancedMetricAvgMemoryUtilization(): MathExpression | Metric ``` ##### `enhancedMetricFunctionCost` ```typescript public enhancedMetricFunctionCost(): MathExpression | Metric ``` ##### `enhancedMetricInitDuration` ```typescript public enhancedMetricInitDuration(): MathExpression | Metric ``` ##### `enhancedMetricMaxCpuTotalTime` ```typescript public enhancedMetricMaxCpuTotalTime(): MathExpression | Metric ``` ##### `enhancedMetricMaxInitDuration` ```typescript public enhancedMetricMaxInitDuration(): MathExpression | Metric ``` ##### `enhancedMetricMaxMemoryUtilization` ```typescript public enhancedMetricMaxMemoryUtilization(): MathExpression | Metric ``` ##### `enhancedMetricMaxTotalMemory` ```typescript public enhancedMetricMaxTotalMemory(): MathExpression | Metric ``` ##### `enhancedMetricP90CpuTotalTime` ```typescript public enhancedMetricP90CpuTotalTime(): MathExpression | Metric ``` ##### `enhancedMetricP90InitDuration` ```typescript public enhancedMetricP90InitDuration(): MathExpression | Metric ``` ##### `enhancedMetricP90MemoryUtilization` ```typescript public enhancedMetricP90MemoryUtilization(): MathExpression | Metric ``` ### LambdaFunctionMetricFactory #### Initializers ```typescript import { LambdaFunctionMetricFactory } from 'cdk-monitoring-constructs' new LambdaFunctionMetricFactory(metricFactory: MetricFactory, props: LambdaFunctionMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | LambdaFunctionMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* LambdaFunctionMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricConcurrentExecutions | *No description.* | | metricFaultCount | *No description.* | | metricFaultRate | *No description.* | | metricInvocationCount | *No description.* | | metricInvocationRate | *No description.* | | metricLatencyInMillis | *No description.* | | metricLatencyP50InMillis | *No description.* | | metricLatencyP90InMillis | *No description.* | | metricLatencyP99InMillis | *No description.* | | metricMaxIteratorAgeInMillis | *No description.* | | metricMaxOffsetLagInNumberOfRecords | *No description.* | | metricProvisionedConcurrencySpilloverInvocations | *No description.* | | metricProvisionedConcurrencySpilloverRate | *No description.* | | metricThrottlesCount | *No description.* | | metricThrottlesRate | *No description.* | | metricTps | *No description.* | --- ##### `metricConcurrentExecutions` ```typescript public metricConcurrentExecutions(): MathExpression | Metric ``` ##### `metricFaultCount` ```typescript public metricFaultCount(): MathExpression | Metric ``` ##### `metricFaultRate` ```typescript public metricFaultRate(): MathExpression | Metric ``` ##### `metricInvocationCount` ```typescript public metricInvocationCount(): MathExpression | Metric ``` ##### `metricInvocationRate` ```typescript public metricInvocationRate(rateComputationMethod?: RateComputationMethod): MathExpression | Metric ``` ###### `rateComputationMethod`^Optional - *Type:* RateComputationMethod --- ##### `metricLatencyInMillis` ```typescript public metricLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### ~~`metricLatencyP50InMillis`~~ ```typescript public metricLatencyP50InMillis(): MathExpression | Metric ``` ##### ~~`metricLatencyP90InMillis`~~ ```typescript public metricLatencyP90InMillis(): MathExpression | Metric ``` ##### ~~`metricLatencyP99InMillis`~~ ```typescript public metricLatencyP99InMillis(): MathExpression | Metric ``` ##### `metricMaxIteratorAgeInMillis` ```typescript public metricMaxIteratorAgeInMillis(): MathExpression | Metric ``` ##### `metricMaxOffsetLagInNumberOfRecords` ```typescript public metricMaxOffsetLagInNumberOfRecords(): MathExpression | Metric ``` ##### `metricProvisionedConcurrencySpilloverInvocations` ```typescript public metricProvisionedConcurrencySpilloverInvocations(): MathExpression | Metric ``` ##### `metricProvisionedConcurrencySpilloverRate` ```typescript public metricProvisionedConcurrencySpilloverRate(): MathExpression | Metric ``` ##### `metricThrottlesCount` ```typescript public metricThrottlesCount(): MathExpression | Metric ``` ##### `metricThrottlesRate` ```typescript public metricThrottlesRate(): MathExpression | Metric ``` ##### ~~`metricTps`~~ ```typescript public metricTps(): MathExpression | Metric ``` ### LambdaFunctionMonitoring #### Initializers ```typescript import { LambdaFunctionMonitoring } from 'cdk-monitoring-constructs' new LambdaFunctionMonitoring(scope: MonitoringScope, props: LambdaFunctionMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | LambdaFunctionMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* LambdaFunctionMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createErrorCountWidget | *No description.* | | createErrorRateWidget | *No description.* | | createInvocationWidget | *No description.* | | createIteratorAgeWidget | *No description.* | | createLambdaInsightsCpuWidget | *No description.* | | createLambdaInsightsFunctionCostWidget | *No description.* | | createLambdaInsightsInitDurationWidget | *No description.* | | createLambdaInsightsMemoryWidget | *No description.* | | createLatencyWidget | *No description.* | | createOffsetLagWidget | *No description.* | | createRateWidget | *No description.* | | createTitleWidget | *No description.* | | createTpsWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createErrorCountWidget` ```typescript public createErrorCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createErrorRateWidget` ```typescript public createErrorRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createInvocationWidget` ```typescript public createInvocationWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createIteratorAgeWidget` ```typescript public createIteratorAgeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLambdaInsightsCpuWidget` ```typescript public createLambdaInsightsCpuWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLambdaInsightsFunctionCostWidget` ```typescript public createLambdaInsightsFunctionCostWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLambdaInsightsInitDurationWidget` ```typescript public createLambdaInsightsInitDurationWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLambdaInsightsMemoryWidget` ```typescript public createLambdaInsightsMemoryWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createOffsetLagWidget` ```typescript public createOffsetLagWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createRateWidget` ```typescript public createRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` ##### `createTpsWidget` ```typescript public createTpsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ageAlarmFactory | AgeAlarmFactory | *No description.* | | alarmFactory | AlarmFactory | *No description.* | | concurrentExecutionsCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuTotalTimeAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | faultCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | faultRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | initDurationAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | invocationCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | invocationCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | invocationRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | isIterator | boolean | *No description.* | | isOffsetLag | boolean | *No description.* | | lambdaInsightsEnabled | boolean | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | latencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | maxIteratorAgeAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | maxIteratorAgeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | maxLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | maxOffsetLagAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | maxOffsetLagMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | memoryUsageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | metricFactory | LambdaFunctionMetricFactory | *No description.* | | namingStrategy | MonitoringNamingStrategy | *No description.* | | p50LatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p90LatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p99LatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | provisionedConcurrencySpilloverInvocationsCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | provisionedConcurrencySpilloverInvocationsRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | taskHealthAlarmFactory | TaskHealthAlarmFactory | *No description.* | | throttlesCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | throttlesRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | tpsAlarmFactory | TpsAlarmFactory | *No description.* | | tpsAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | tpsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | enhancedMetricFactory | LambdaFunctionEnhancedMetricFactory | *No description.* | | enhancedMetricFunctionCostMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | enhancedMonitoringAvgCpuTotalTimeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | enhancedMonitoringAvgInitDurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | enhancedMonitoringAvgMemoryUtilizationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | enhancedMonitoringMaxCpuTotalTimeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | enhancedMonitoringMaxInitDurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | enhancedMonitoringMaxMemoryUtilizationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | enhancedMonitoringP90CpuTotalTimeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | enhancedMonitoringP90InitDurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | enhancedMonitoringP90MemoryUtilizationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | functionUrl | string | *No description.* | --- ##### `ageAlarmFactory`^Required ```typescript public readonly ageAlarmFactory: AgeAlarmFactory; ``` - *Type:* AgeAlarmFactory --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `concurrentExecutionsCountMetric`^Required ```typescript public readonly concurrentExecutionsCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuTotalTimeAnnotations`^Required ```typescript public readonly cpuTotalTimeAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `faultCountMetric`^Required ```typescript public readonly faultCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `faultRateMetric`^Required ```typescript public readonly faultRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `initDurationAnnotations`^Required ```typescript public readonly initDurationAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `invocationCountAnnotations`^Required ```typescript public readonly invocationCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `invocationCountMetric`^Required ```typescript public readonly invocationCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `invocationRateAnnotations`^Required ```typescript public readonly invocationRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `isIterator`^Required ```typescript public readonly isIterator: boolean; ``` - *Type:* boolean --- ##### `isOffsetLag`^Required ```typescript public readonly isOffsetLag: boolean; ``` - *Type:* boolean --- ##### `lambdaInsightsEnabled`^Required ```typescript public readonly lambdaInsightsEnabled: boolean; ``` - *Type:* boolean --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `latencyAnnotations`^Required ```typescript public readonly latencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `maxIteratorAgeAnnotations`^Required ```typescript public readonly maxIteratorAgeAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `maxIteratorAgeMetric`^Required ```typescript public readonly maxIteratorAgeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `maxLatencyMetric`^Required ```typescript public readonly maxLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `maxOffsetLagAnnotations`^Required ```typescript public readonly maxOffsetLagAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `maxOffsetLagMetric`^Required ```typescript public readonly maxOffsetLagMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `memoryUsageAnnotations`^Required ```typescript public readonly memoryUsageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `metricFactory`^Required ```typescript public readonly metricFactory: LambdaFunctionMetricFactory; ``` - *Type:* LambdaFunctionMetricFactory --- ##### `namingStrategy`^Required ```typescript public readonly namingStrategy: MonitoringNamingStrategy; ``` - *Type:* MonitoringNamingStrategy --- ##### `p50LatencyMetric`^Required ```typescript public readonly p50LatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p90LatencyMetric`^Required ```typescript public readonly p90LatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p99LatencyMetric`^Required ```typescript public readonly p99LatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `provisionedConcurrencySpilloverInvocationsCountMetric`^Required ```typescript public readonly provisionedConcurrencySpilloverInvocationsCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `provisionedConcurrencySpilloverInvocationsRateMetric`^Required ```typescript public readonly provisionedConcurrencySpilloverInvocationsRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `taskHealthAlarmFactory`^Required ```typescript public readonly taskHealthAlarmFactory: TaskHealthAlarmFactory; ``` - *Type:* TaskHealthAlarmFactory --- ##### `throttlesCountMetric`^Required ```typescript public readonly throttlesCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `throttlesRateMetric`^Required ```typescript public readonly throttlesRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `tpsAlarmFactory`^Required ```typescript public readonly tpsAlarmFactory: TpsAlarmFactory; ``` - *Type:* TpsAlarmFactory --- ##### `tpsAnnotations`^Required ```typescript public readonly tpsAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `tpsMetric`^Required ```typescript public readonly tpsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `enhancedMetricFactory`^Optional ```typescript public readonly enhancedMetricFactory: LambdaFunctionEnhancedMetricFactory; ``` - *Type:* LambdaFunctionEnhancedMetricFactory --- ##### `enhancedMetricFunctionCostMetric`^Optional ```typescript public readonly enhancedMetricFunctionCostMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `enhancedMonitoringAvgCpuTotalTimeMetric`^Optional ```typescript public readonly enhancedMonitoringAvgCpuTotalTimeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `enhancedMonitoringAvgInitDurationMetric`^Optional ```typescript public readonly enhancedMonitoringAvgInitDurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `enhancedMonitoringAvgMemoryUtilizationMetric`^Optional ```typescript public readonly enhancedMonitoringAvgMemoryUtilizationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `enhancedMonitoringMaxCpuTotalTimeMetric`^Optional ```typescript public readonly enhancedMonitoringMaxCpuTotalTimeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `enhancedMonitoringMaxInitDurationMetric`^Optional ```typescript public readonly enhancedMonitoringMaxInitDurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `enhancedMonitoringMaxMemoryUtilizationMetric`^Optional ```typescript public readonly enhancedMonitoringMaxMemoryUtilizationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `enhancedMonitoringP90CpuTotalTimeMetric`^Optional ```typescript public readonly enhancedMonitoringP90CpuTotalTimeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `enhancedMonitoringP90InitDurationMetric`^Optional ```typescript public readonly enhancedMonitoringP90InitDurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `enhancedMonitoringP90MemoryUtilizationMetric`^Optional ```typescript public readonly enhancedMonitoringP90MemoryUtilizationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `functionUrl`^Optional ```typescript public readonly functionUrl: string; ``` - *Type:* string --- ### LatencyAlarmFactory #### Initializers ```typescript import { LatencyAlarmFactory } from 'cdk-monitoring-constructs' new LatencyAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addCustomDurationAlarm | *No description.* | | addDurationAlarm | *No description.* | | addIntegrationLatencyAlarm | *No description.* | | addJvmGarbageCollectionDurationAlarm | *No description.* | | addLatencyAlarm | *No description.* | --- ##### `addCustomDurationAlarm` ```typescript public addCustomDurationAlarm(metric: MathExpression | Metric, latencyType: LatencyType, props: DurationThreshold, durationName: string, disambiguator?: string, additionalAlarmNameSuffix?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `latencyType`^Required - *Type:* LatencyType --- ###### `props`^Required - *Type:* DurationThreshold --- ###### `durationName`^Required - *Type:* string --- ###### `disambiguator`^Optional - *Type:* string --- ###### `additionalAlarmNameSuffix`^Optional - *Type:* string --- ##### `addDurationAlarm` ```typescript public addDurationAlarm(metric: MathExpression | Metric, latencyType: LatencyType, props: DurationThreshold, disambiguator?: string, additionalAlarmNameSuffix?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `latencyType`^Required - *Type:* LatencyType --- ###### `props`^Required - *Type:* DurationThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ###### `additionalAlarmNameSuffix`^Optional - *Type:* string --- ##### `addIntegrationLatencyAlarm` ```typescript public addIntegrationLatencyAlarm(metric: MathExpression | Metric, latencyType: LatencyType, props: LatencyThreshold, disambiguator?: string, additionalAlarmNameSuffix?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `latencyType`^Required - *Type:* LatencyType --- ###### `props`^Required - *Type:* LatencyThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ###### `additionalAlarmNameSuffix`^Optional - *Type:* string --- ##### `addJvmGarbageCollectionDurationAlarm` ```typescript public addJvmGarbageCollectionDurationAlarm(metric: MathExpression | Metric, latencyType: LatencyType, props: DurationThreshold, disambiguator?: string, additionalAlarmNameSuffix?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `latencyType`^Required - *Type:* LatencyType --- ###### `props`^Required - *Type:* DurationThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ###### `additionalAlarmNameSuffix`^Optional - *Type:* string --- ##### `addLatencyAlarm` ```typescript public addLatencyAlarm(metric: MathExpression | Metric, latencyType: LatencyType, props: LatencyThreshold, disambiguator?: string, additionalAlarmNameSuffix?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `latencyType`^Required - *Type:* LatencyType --- ###### `props`^Required - *Type:* LatencyThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ###### `additionalAlarmNameSuffix`^Optional - *Type:* string --- ### LogLevelAlarmFactory #### Initializers ```typescript import { LogLevelAlarmFactory } from 'cdk-monitoring-constructs' new LogLevelAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addLogCountAlarm | *No description.* | --- ##### `addLogCountAlarm` ```typescript public addLogCountAlarm(metric: MathExpression | Metric, logLevel: LogLevel, props: LogLevelCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `logLevel`^Required - *Type:* LogLevel --- ###### `props`^Required - *Type:* LogLevelCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### LogMonitoring Monitors a CloudWatch log group for various patterns. #### Initializers ```typescript import { LogMonitoring } from 'cdk-monitoring-constructs' new LogMonitoring(scope: MonitoringScope, props: LogMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | LogMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* LogMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createIncomingLogsWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createIncomingLogsWidget` ```typescript public createIncomingLogsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | incomingLogEventsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | limit | number | *No description.* | | logGroupName | string | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | usageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | filterExpressions | string[] | *No description.* | | logGroupUrl | string | *No description.* | | pattern | string | *No description.* | | title | string | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `incomingLogEventsMetric`^Required ```typescript public readonly incomingLogEventsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `limit`^Required ```typescript public readonly limit: number; ``` - *Type:* number --- ##### `logGroupName`^Required ```typescript public readonly logGroupName: string; ``` - *Type:* string --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `usageAnnotations`^Required ```typescript public readonly usageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `filterExpressions`^Optional ```typescript public readonly filterExpressions: string[]; ``` - *Type:* string[] --- ##### `logGroupUrl`^Optional ```typescript public readonly logGroupUrl: string; ``` - *Type:* string --- ##### `pattern`^Optional ```typescript public readonly pattern: string; ``` - *Type:* string --- ##### `title`^Optional ```typescript public readonly title: string; ``` - *Type:* string --- ### MetricFactory #### Initializers ```typescript import { MetricFactory } from 'cdk-monitoring-constructs' new MetricFactory(scope: Construct, props?: MetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | props | MetricFactoryProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `props`^Optional - *Type:* MetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | adaptMetric | Adapts properties of a foreign metric (metric created outside of this metric factory) to comply with the global defaults. | | adaptMetricPreservingPeriod | Adapts properties of a foreign metric (metric created outside of this metric factory) to comply with the global defaults. | | addAdditionalDimensions | Merges the given additional dimensions to the given target dimension hash. | | createMetric | Factory method that creates a metric. | | createMetricAnomalyDetection | Factory method that creates anomaly detection on a metric. | | createMetricMath | Factory method that creates a metric math expression. | | createMetricSearch | Factory method that creates a metric search query. | | divideMetric | Creates a metric math expression that divides the given metric by given coefficient. | | getNamespaceWithFallback | Returns the given namespace (if defined) or the global namespace as a fallback. | | multiplyMetric | Creates a metric math expression that multiplies the given metric by given coefficient. | | sanitizeMetricExpressionIdSuffix | Helper method that helps to sanitize the given expression ID and removes all invalid characters. | | toRate | Creates a metric math expression that computes a rate from a regular metric. | --- ##### `adaptMetric` ```typescript public adaptMetric(metric: MathExpression | Metric): MathExpression | Metric ``` Adapts properties of a foreign metric (metric created outside of this metric factory) to comply with the global defaults. Might modify namespace and metric period. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric metric to be adapted. --- ##### `adaptMetricPreservingPeriod` ```typescript public adaptMetricPreservingPeriod(metric: MathExpression | Metric): MathExpression | Metric ``` Adapts properties of a foreign metric (metric created outside of this metric factory) to comply with the global defaults. Might modify namespace. Preserves metric period. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric metric to be adapted. --- ##### `addAdditionalDimensions` ```typescript public addAdditionalDimensions(target: {[ key: string ]: string}, additionalDimensions: {[ key: string ]: string}): void ``` Merges the given additional dimensions to the given target dimension hash. All existing dimensions with the same key are replaced. ###### `target`^Required - *Type:* {[ key: string ]: string} target dimension hash to update. --- ###### `additionalDimensions`^Required - *Type:* {[ key: string ]: string} additional dimensions. --- ##### `createMetric` ```typescript public createMetric(metricName: string, statistic: MetricStatistic, label?: string, dimensionsMap?: {[ key: string ]: string}, color?: string, namespace?: string, period?: Duration, region?: string, account?: string): MathExpression | Metric ``` Factory method that creates a metric. The metric properties will already be updated to comply with the global defaults. ###### `metricName`^Required - *Type:* string metric name. --- ###### `statistic`^Required - *Type:* MetricStatistic aggregation statistic to use. --- ###### `label`^Optional - *Type:* string metric label; if undefined, metric name is used by CloudWatch --- ###### `dimensionsMap`^Optional - *Type:* {[ key: string ]: string} additional dimensions to be added. --- ###### `color`^Optional - *Type:* string metric color; if undefined, uses a CloudWatch provided color (preferred) --- ###### `namespace`^Optional - *Type:* string specify a custom namespace; if undefined, uses the global default --- ###### `period`^Optional - *Type:* aws-cdk-lib.Duration specify a custom period; if undefined, uses the global default --- ###### `region`^Optional - *Type:* string specify a custom region; if undefined, uses the global default --- ###### `account`^Optional - *Type:* string specify a custom account; if undefined, uses the global default --- ##### `createMetricAnomalyDetection` ```typescript public createMetricAnomalyDetection(metric: IMetric, stdev: number, label: string, color?: string, expressionId?: string, period?: Duration, region?: string, account?: string): MathExpression | Metric ``` Factory method that creates anomaly detection on a metric. Anomaly occurs whenever a metric value falls outside of a precomputed range of predicted values. The detection does not need any setup. The model will start learning automatically and should be ready in a few minutes. Usually, the anomaly detection is paired with an alarm. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html) ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric metric to detect anomaly detection of. --- ###### `stdev`^Required - *Type:* number standard deviation, basically the tolerance / band thickness. --- ###### `label`^Required - *Type:* string metric label (required, as there is no reasonable default). --- ###### `color`^Optional - *Type:* string metric color; if undefined, uses a CloudWatch provided color (preferred) --- ###### `expressionId`^Optional - *Type:* string expression ID of the metric; uses `m1` if undefined --- ###### `period`^Optional - *Type:* aws-cdk-lib.Duration specify a custom period; if undefined, uses the global default --- ###### `region`^Optional - *Type:* string specify a custom region; if undefined, uses the global default --- ###### `account`^Optional - *Type:* string specify a custom account; if undefined, uses the global default --- ##### `createMetricMath` ```typescript public createMetricMath(expression: string, usingMetrics: {[ key: string ]: IMetric}, label: string, color?: string, period?: Duration, region?: string, account?: string): MathExpression | Metric ``` Factory method that creates a metric math expression. The metric properties will already be updated to comply with the global defaults. ###### `expression`^Required - *Type:* string CloudWatch metric math expression (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html). --- ###### `usingMetrics`^Required - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.IMetric} map of metrics, where keys are expression IDs (used in the expression) and values are metrics. --- ###### `label`^Required - *Type:* string metric label (required, as there is no reasonable default). --- ###### `color`^Optional - *Type:* string metric color; if undefined, uses a CloudWatch provided color (preferred) --- ###### `period`^Optional - *Type:* aws-cdk-lib.Duration specify a custom period; if undefined, uses the global default --- ###### `region`^Optional - *Type:* string - Deprecated: Use createSearchMetric if doing cross region search. --- ###### `account`^Optional - *Type:* string - Deprecated: Use createSearchMetric if doing cross region search. --- ##### `createMetricSearch` ```typescript public createMetricSearch(query: string, dimensionsMap: {[ key: string ]: string}, statistic: MetricStatistic, namespace?: string, label?: string, period?: Duration, region?: string, account?: string): MathExpression ``` Factory method that creates a metric search query. The metric properties will already be updated to comply with the global defaults. If you want to match "any value" of a specific dimension, please use `undefined` value representation in your consumer language. (For example, `undefined as any as string` in TypeScript, due to JSII typing quirks.) ###### `query`^Required - *Type:* string metric search query (the same as the search query prompt in CloudWatch AWS Console), it might also be empty. --- ###### `dimensionsMap`^Required - *Type:* {[ key: string ]: string} dimensions, further narrowing the search results; use `undefined` if you want to represent "any value" (in TS: `undefined as any as string`) --- ###### `statistic`^Required - *Type:* MetricStatistic aggregation statistic to use. --- ###### `namespace`^Optional - *Type:* string specify a custom namespace; if undefined, uses the global default --- ###### `label`^Optional - *Type:* string specify custom label for search metrics; default is " " as it cannot be empty string --- ###### `period`^Optional - *Type:* aws-cdk-lib.Duration specify a custom period; if undefined, uses the global default --- ###### `region`^Optional - *Type:* string specify a custom region; if undefined, uses the global default --- ###### `account`^Optional - *Type:* string specify a custom account; if undefined, uses the global default --- ##### `divideMetric` ```typescript public divideMetric(metric: MathExpression | Metric, divisor: number, label: string, expressionId?: string): MathExpression | Metric ``` Creates a metric math expression that divides the given metric by given coefficient. Does nothing if the divisor is one. Preserves the metric period. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric metric to multiply. --- ###### `divisor`^Required - *Type:* number divisor (must be > 1). --- ###### `label`^Required - *Type:* string expression label. --- ###### `expressionId`^Optional - *Type:* string expression ID of the metric; uses `m1` if undefined --- ##### `getNamespaceWithFallback` ```typescript public getNamespaceWithFallback(value?: string): string ``` Returns the given namespace (if defined) or the global namespace as a fallback. If there is no namespace to fallback to (neither the custom or the default one), it will fail. ###### `value`^Optional - *Type:* string custom namespace. --- ##### `multiplyMetric` ```typescript public multiplyMetric(metric: MathExpression | Metric, multiplier: number, label: string, expressionId?: string): MathExpression | Metric ``` Creates a metric math expression that multiplies the given metric by given coefficient. Does nothing if the multiplier is one. Preserves the metric period. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric metric to multiply. --- ###### `multiplier`^Required - *Type:* number multiplier (must be > 1). --- ###### `label`^Required - *Type:* string expression label. --- ###### `expressionId`^Optional - *Type:* string expression ID of the metric; uses `m1` if undefined --- ##### `sanitizeMetricExpressionIdSuffix` ```typescript public sanitizeMetricExpressionIdSuffix(expressionId: string): string ``` Helper method that helps to sanitize the given expression ID and removes all invalid characters. Valid expression ID regexp is the following: ^[a-z][a-zA-Z0-9_]*$ As this is just to validate a suffix and not the whole ID, we do not have to verify the first lower case letter. ###### `expressionId`^Required - *Type:* string expression ID to sanitize. --- ##### `toRate` ```typescript public toRate(metric: MathExpression | Metric, method: RateComputationMethod, addStatsToLabel?: boolean, expressionId?: string, fillWithZeroes?: boolean): MathExpression | Metric ``` Creates a metric math expression that computes a rate from a regular metric. For example, it allows you to compute rate per second (TPS), per minute, or just an average of your transactions. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric metric to calculate the rate from. --- ###### `method`^Required - *Type:* RateComputationMethod rate computation method. --- ###### `addStatsToLabel`^Optional - *Type:* boolean add detailed statistics (min, max, average) to the label. --- ###### `expressionId`^Optional - *Type:* string expression ID of the metric; uses `m1` if undefined --- ###### `fillWithZeroes`^Optional - *Type:* boolean if TRUE, the final metric will be zero-filled (0 on no data); false if undefined --- ### Monitoring - *Implements:* IDashboardSegment, IDynamicDashboardSegment An independent unit of monitoring. This is the base for all monitoring classes with alarm support. #### Initializers ```typescript import { Monitoring } from 'cdk-monitoring-constructs' new Monitoring(scope: MonitoringScope, props?: BaseMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | BaseMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Optional - *Type:* BaseMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ### MonitoringAspect - *Implements:* aws-cdk-lib.IAspect A CDK aspect that adds support for monitoring all resources within scope. #### Initializers ```typescript import { MonitoringAspect } from 'cdk-monitoring-constructs' new MonitoringAspect(monitoringFacade: MonitoringFacade, props?: MonitoringAspectProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | monitoringFacade | MonitoringFacade | *No description.* | | props | MonitoringAspectProps | *No description.* | --- ##### `monitoringFacade`^Required - *Type:* MonitoringFacade --- ##### `props`^Optional - *Type:* MonitoringAspectProps --- #### Methods | **Name** | **Description** | | --- | --- | | visit | All aspects can visit an IConstruct. | --- ##### `visit` ```typescript public visit(node: IConstruct): void ``` All aspects can visit an IConstruct. ###### `node`^Required - *Type:* constructs.IConstruct --- ### MonitoringHeaderWidget #### Initializers ```typescript import { MonitoringHeaderWidget } from 'cdk-monitoring-constructs' new MonitoringHeaderWidget(props: MonitoringHeaderWidgetProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | MonitoringHeaderWidgetProps | *No description.* | --- ##### `props`^Required - *Type:* MonitoringHeaderWidgetProps --- #### Methods | **Name** | **Description** | | --- | --- | | position | Place the widget at a given position. | | toJson | Return the widget JSON for use in the dashboard. | --- ##### `position` ```typescript public position(x: number, y: number): void ``` Place the widget at a given position. ###### `x`^Required - *Type:* number --- ###### `y`^Required - *Type:* number --- ##### `toJson` ```typescript public toJson(): any[] ``` Return the widget JSON for use in the dashboard. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | height | number | The amount of vertical grid units the widget will take up. | | width | number | The amount of horizontal grid units the widget will take up. | | warnings | string[] | Any warnings that are produced as a result of putting together this widget. | | warningsV2 | {[ key: string ]: string} | Any warnings that are produced as a result of putting together this widget. | --- ##### `height`^Required ```typescript public readonly height: number; ``` - *Type:* number The amount of vertical grid units the widget will take up. --- ##### `width`^Required ```typescript public readonly width: number; ``` - *Type:* number The amount of horizontal grid units the widget will take up. --- ##### `warnings`^Optional ```typescript public readonly warnings: string[]; ``` - *Type:* string[] Any warnings that are produced as a result of putting together this widget. --- ##### `warningsV2`^Optional ```typescript public readonly warningsV2: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Any warnings that are produced as a result of putting together this widget. --- ### MonitoringNamingStrategy Utility class to unify approach to naming monitoring sections. > [https://docs.aws.amazon.com/cdk/latest/guide/tokens.html#tokens_lazy](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html#tokens_lazy) #### Initializers ```typescript import { MonitoringNamingStrategy } from 'cdk-monitoring-constructs' new MonitoringNamingStrategy(input: NameResolutionInput) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | input | NameResolutionInput | *No description.* | --- ##### `input`^Required - *Type:* NameResolutionInput --- #### Methods | **Name** | **Description** | | --- | --- | | resolveAlarmFriendlyName | *No description.* | | resolveHumanReadableName | *No description.* | --- ##### `resolveAlarmFriendlyName` ```typescript public resolveAlarmFriendlyName(): string ``` ##### `resolveHumanReadableName` ```typescript public resolveHumanReadableName(): string ``` #### Static Functions | **Name** | **Description** | | --- | --- | | isAlarmFriendly | *No description.* | --- ##### `isAlarmFriendly` ```typescript import { MonitoringNamingStrategy } from 'cdk-monitoring-constructs' MonitoringNamingStrategy.isAlarmFriendly(str: string) ``` ###### `str`^Required - *Type:* string --- ### MultipleAlarmActionStrategy - *Implements:* IAlarmActionStrategy Alarm action strategy that combines multiple actions in the same order as they were given. #### Initializers ```typescript import { MultipleAlarmActionStrategy } from 'cdk-monitoring-constructs' new MultipleAlarmActionStrategy(actions: IAlarmActionStrategy[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | actions | IAlarmActionStrategy[] | *No description.* | --- ##### `actions`^Required - *Type:* IAlarmActionStrategy[] --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarmActions | *No description.* | | flattenedAlarmActions | Returns list of alarm actions where any nested instances of MultipleAlarmActionStrategy are flattened. | --- ##### `addAlarmActions` ```typescript public addAlarmActions(props: AlarmActionStrategyProps): void ``` ###### `props`^Required - *Type:* AlarmActionStrategyProps --- ##### `flattenedAlarmActions` ```typescript public flattenedAlarmActions(): IAlarmActionStrategy[] ``` Returns list of alarm actions where any nested instances of MultipleAlarmActionStrategy are flattened. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | actions | IAlarmActionStrategy[] | *No description.* | --- ##### `actions`^Required ```typescript public readonly actions: IAlarmActionStrategy[]; ``` - *Type:* IAlarmActionStrategy[] --- ### NetworkLoadBalancerMetricFactory - *Implements:* ILoadBalancerMetricFactory Metric factory to create metrics for network load-balanced service. #### Initializers ```typescript import { NetworkLoadBalancerMetricFactory } from 'cdk-monitoring-constructs' new NetworkLoadBalancerMetricFactory(metricFactory: MetricFactory, props: NetworkLoadBalancerMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | NetworkLoadBalancerMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* NetworkLoadBalancerMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricActiveConnectionCount | *No description.* | | metricClientResetCount | *No description.* | | metricElbResetCount | *No description.* | | metricHealthyTaskCount | *No description.* | | metricHealthyTaskInPercent | *No description.* | | metricNewConnectionCount | *No description.* | | metricProcessedBytesMin | *No description.* | | metricTargetResetCount | *No description.* | | metricUnhealthyRoutingCount | *No description.* | | metricUnhealthyTaskCount | *No description.* | --- ##### `metricActiveConnectionCount` ```typescript public metricActiveConnectionCount(): MathExpression | Metric ``` ##### `metricClientResetCount` ```typescript public metricClientResetCount(): MathExpression | Metric ``` ##### `metricElbResetCount` ```typescript public metricElbResetCount(): MathExpression | Metric ``` ##### `metricHealthyTaskCount` ```typescript public metricHealthyTaskCount(): MathExpression | Metric ``` ##### `metricHealthyTaskInPercent` ```typescript public metricHealthyTaskInPercent(): MathExpression | Metric ``` ##### `metricNewConnectionCount` ```typescript public metricNewConnectionCount(): MathExpression | Metric ``` ##### `metricProcessedBytesMin` ```typescript public metricProcessedBytesMin(): MathExpression | Metric ``` ##### `metricTargetResetCount` ```typescript public metricTargetResetCount(): MathExpression | Metric ``` ##### `metricUnhealthyRoutingCount` ```typescript public metricUnhealthyRoutingCount(): MathExpression | Metric ``` ##### `metricUnhealthyTaskCount` ```typescript public metricUnhealthyTaskCount(): MathExpression | Metric ``` ### NetworkLoadBalancerMonitoring #### Initializers ```typescript import { NetworkLoadBalancerMonitoring } from 'cdk-monitoring-constructs' new NetworkLoadBalancerMonitoring(scope: MonitoringScope, props: NetworkLoadBalancerMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | NetworkLoadBalancerMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* NetworkLoadBalancerMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ### NoopAlarmActionStrategy - *Implements:* IAlarmActionStrategy Alarm action strategy that does not add any actions. #### Initializers ```typescript import { NoopAlarmActionStrategy } from 'cdk-monitoring-constructs' new NoopAlarmActionStrategy() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarmActions | *No description.* | --- ##### `addAlarmActions` ```typescript public addAlarmActions(_props: AlarmActionStrategyProps): void ``` ###### `_props`^Required - *Type:* AlarmActionStrategyProps --- ### OpenSearchBackportedMetrics Backported set of metric functions added in. > [https://github.com/aws/aws-cdk/releases/tag/v1.73.0](https://github.com/aws/aws-cdk/releases/tag/v1.73.0) #### Initializers ```typescript import { OpenSearchBackportedMetrics } from 'cdk-monitoring-constructs' new OpenSearchBackportedMetrics(domain: CfnDomain | IDomain | CfnDomain | IDomain) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | domain |

aws-cdk-lib.aws_opensearchservice.CfnDomain \| aws-cdk-lib.aws_opensearchservice.IDomain \| aws-cdk-lib.aws_elasticsearch.CfnDomain \| aws-cdk-lib.aws_elasticsearch.IDomain

| *No description.* | --- ##### `domain`^Required - *Type:* aws-cdk-lib.aws_opensearchservice.CfnDomain | aws-cdk-lib.aws_opensearchservice.IDomain | aws-cdk-lib.aws_elasticsearch.CfnDomain | aws-cdk-lib.aws_elasticsearch.IDomain --- #### Methods | **Name** | **Description** | | --- | --- | | metric | Return the given named metric for this Domain. | | metricAutomatedSnapshotFailure | Metric for automated snapshot failures. | | metricClusterIndexWriteBlocked | Metric for the cluster blocking index writes. | | metricClusterIndexWritesBlocked | Metric for the cluster blocking index writes. | | metricClusterStatusRed | Metric for the time the cluster status is red. | | metricClusterStatusYellow | Metric for the time the cluster status is yellow. | | metricCPUUtilization | Metric for CPU utilization. | | metricFreeStorageSpace | Metric for the storage space of nodes in the cluster. | | metricIndexingLatency | Metric for indexing latency. | | metricJVMMemoryPressure | Metric for JVM memory pressure. | | metricKMSKeyError | Metric for KMS key errors. | | metricKMSKeyInaccessible | Metric for KMS key being inaccessible. | | metricMasterCPUUtilization | Metric for master CPU utilization. | | metricMasterJVMMemoryPressure | Metric for master JVM memory pressure. | | metricNodes | Metric for the number of nodes. | | metricSearchableDocuments | Metric for number of searchable documents. | | metricSearchLatency | Metric for search latency. | --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Domain. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAutomatedSnapshotFailure` ```typescript public metricAutomatedSnapshotFailure(props?: MetricOptions): Metric ``` Metric for automated snapshot failures. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricClusterIndexWriteBlocked`~~ ```typescript public metricClusterIndexWriteBlocked(props?: MetricOptions): Metric ``` Metric for the cluster blocking index writes. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricClusterIndexWritesBlocked` ```typescript public metricClusterIndexWritesBlocked(props?: MetricOptions): Metric ``` Metric for the cluster blocking index writes. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricClusterStatusRed` ```typescript public metricClusterStatusRed(props?: MetricOptions): Metric ``` Metric for the time the cluster status is red. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricClusterStatusYellow` ```typescript public metricClusterStatusYellow(props?: MetricOptions): Metric ``` Metric for the time the cluster status is yellow. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCPUUtilization` ```typescript public metricCPUUtilization(props?: MetricOptions): Metric ``` Metric for CPU utilization. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFreeStorageSpace` ```typescript public metricFreeStorageSpace(props?: MetricOptions): Metric ``` Metric for the storage space of nodes in the cluster. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricIndexingLatency` ```typescript public metricIndexingLatency(props?: MetricOptions): Metric ``` Metric for indexing latency. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricJVMMemoryPressure` ```typescript public metricJVMMemoryPressure(props?: MetricOptions): Metric ``` Metric for JVM memory pressure. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricKMSKeyError` ```typescript public metricKMSKeyError(props?: MetricOptions): Metric ``` Metric for KMS key errors. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricKMSKeyInaccessible` ```typescript public metricKMSKeyInaccessible(props?: MetricOptions): Metric ``` Metric for KMS key being inaccessible. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMasterCPUUtilization` ```typescript public metricMasterCPUUtilization(props?: MetricOptions): Metric ``` Metric for master CPU utilization. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMasterJVMMemoryPressure` ```typescript public metricMasterJVMMemoryPressure(props?: MetricOptions): Metric ``` Metric for master JVM memory pressure. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNodes` ```typescript public metricNodes(props?: MetricOptions): Metric ``` Metric for the number of nodes. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSearchableDocuments` ```typescript public metricSearchableDocuments(props?: MetricOptions): Metric ``` Metric for number of searchable documents. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSearchLatency` ```typescript public metricSearchLatency(props?: MetricOptions): Metric ``` Metric for search latency. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ### OpenSearchClusterAlarmFactory #### Initializers ```typescript import { OpenSearchClusterAlarmFactory } from 'cdk-monitoring-constructs' new OpenSearchClusterAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addAutomatedSnapshotFailureAlarm | *No description.* | | addClusterIndexWritesBlockedAlarm | *No description.* | | addClusterNodeCountAlarm | *No description.* | | addClusterStatusAlarm | *No description.* | | addKmsKeyErrorAlarm | *No description.* | | addKmsKeyInaccessibleAlarm | *No description.* | --- ##### `addAutomatedSnapshotFailureAlarm` ```typescript public addAutomatedSnapshotFailureAlarm(metric: MathExpression | Metric, props: OpenSearchClusterAutomatedSnapshotFailureThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* OpenSearchClusterAutomatedSnapshotFailureThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addClusterIndexWritesBlockedAlarm` ```typescript public addClusterIndexWritesBlockedAlarm(metric: MathExpression | Metric, props: OpenSearchClusterIndexWritesBlockedThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* OpenSearchClusterIndexWritesBlockedThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addClusterNodeCountAlarm` ```typescript public addClusterNodeCountAlarm(metric: MathExpression | Metric, props: OpenSearchClusterNodesThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* OpenSearchClusterNodesThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addClusterStatusAlarm` ```typescript public addClusterStatusAlarm(metric: MathExpression | Metric, props: OpenSearchClusterStatusCustomization, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* OpenSearchClusterStatusCustomization --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addKmsKeyErrorAlarm` ```typescript public addKmsKeyErrorAlarm(metric: MathExpression | Metric, props: OpenSearchKmsKeyErrorThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* OpenSearchKmsKeyErrorThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addKmsKeyInaccessibleAlarm` ```typescript public addKmsKeyInaccessibleAlarm(metric: MathExpression | Metric, props: OpenSearchKmsKeyInaccessibleThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* OpenSearchKmsKeyInaccessibleThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### OpenSearchClusterMetricFactory #### Initializers ```typescript import { OpenSearchClusterMetricFactory } from 'cdk-monitoring-constructs' new OpenSearchClusterMetricFactory(metricFactory: MetricFactory, props: OpenSearchClusterMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | OpenSearchClusterMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* OpenSearchClusterMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAutomatedSnapshotFailure | *No description.* | | metricClusterIndexWriteBlocked | *No description.* | | metricClusterIndexWritesBlocked | *No description.* | | metricClusterStatusRed | *No description.* | | metricClusterStatusYellow | *No description.* | | metricCpuUsage | *No description.* | | metricDiskSpaceUsageInPercent | *No description.* | | metricIndexingLatencyP50InMillis | *No description.* | | metricIndexingLatencyP90InMillis | *No description.* | | metricIndexingLatencyP99InMillis | *No description.* | | metricJvmMemoryPressure | *No description.* | | metricKmsKeyError | *No description.* | | metricKmsKeyInaccessible | *No description.* | | metricMasterCpuUsage | *No description.* | | metricMasterJvmMemoryPressure | *No description.* | | metricNodes | *No description.* | | metricSearchCount | *No description.* | | metricSearchLatencyP50InMillis | *No description.* | | metricSearchLatencyP90InMillis | *No description.* | | metricSearchLatencyP99InMillis | *No description.* | | metricSearchRate | *No description.* | | metricTps | *No description.* | --- ##### `metricAutomatedSnapshotFailure` ```typescript public metricAutomatedSnapshotFailure(): MathExpression | Metric ``` ##### ~~`metricClusterIndexWriteBlocked`~~ ```typescript public metricClusterIndexWriteBlocked(): MathExpression | Metric ``` ##### `metricClusterIndexWritesBlocked` ```typescript public metricClusterIndexWritesBlocked(): MathExpression | Metric ``` ##### `metricClusterStatusRed` ```typescript public metricClusterStatusRed(): MathExpression | Metric ``` ##### `metricClusterStatusYellow` ```typescript public metricClusterStatusYellow(): MathExpression | Metric ``` ##### `metricCpuUsage` ```typescript public metricCpuUsage(): MathExpression | Metric ``` ##### `metricDiskSpaceUsageInPercent` ```typescript public metricDiskSpaceUsageInPercent(): MathExpression | Metric ``` ##### `metricIndexingLatencyP50InMillis` ```typescript public metricIndexingLatencyP50InMillis(): MathExpression | Metric ``` ##### `metricIndexingLatencyP90InMillis` ```typescript public metricIndexingLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricIndexingLatencyP99InMillis` ```typescript public metricIndexingLatencyP99InMillis(): MathExpression | Metric ``` ##### `metricJvmMemoryPressure` ```typescript public metricJvmMemoryPressure(): MathExpression | Metric ``` ##### `metricKmsKeyError` ```typescript public metricKmsKeyError(): MathExpression | Metric ``` ##### `metricKmsKeyInaccessible` ```typescript public metricKmsKeyInaccessible(): MathExpression | Metric ``` ##### `metricMasterCpuUsage` ```typescript public metricMasterCpuUsage(): MathExpression | Metric ``` ##### `metricMasterJvmMemoryPressure` ```typescript public metricMasterJvmMemoryPressure(): MathExpression | Metric ``` ##### `metricNodes` ```typescript public metricNodes(): MathExpression | Metric ``` ##### `metricSearchCount` ```typescript public metricSearchCount(): Metric ``` ##### `metricSearchLatencyP50InMillis` ```typescript public metricSearchLatencyP50InMillis(): MathExpression | Metric ``` ##### `metricSearchLatencyP90InMillis` ```typescript public metricSearchLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricSearchLatencyP99InMillis` ```typescript public metricSearchLatencyP99InMillis(): MathExpression | Metric ``` ##### `metricSearchRate` ```typescript public metricSearchRate(rateComputationMethod?: RateComputationMethod): MathExpression | Metric ``` ###### `rateComputationMethod`^Optional - *Type:* RateComputationMethod --- ##### ~~`metricTps`~~ ```typescript public metricTps(): MathExpression | Metric ``` ### OpenSearchClusterMonitoring #### Initializers ```typescript import { OpenSearchClusterMonitoring } from 'cdk-monitoring-constructs' new OpenSearchClusterMonitoring(scope: MonitoringScope, props: OpenSearchClusterMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | OpenSearchClusterMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* OpenSearchClusterMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | automatedSnapshotFailureMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | clusterAlarmFactory | OpenSearchClusterAlarmFactory | *No description.* | | clusterAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | clusterStatusRedMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | clusterStatusYellowMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | diskSpaceUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | indexingLatencyAlarmFactory | LatencyAlarmFactory | *No description.* | | indexingLatencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | indexWriteBlockedMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | jvmMemoryPressureMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | kmsKeyErrorMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | kmsKeyInaccessibleMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | masterCpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | masterJvmMemoryPressureMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | masterUsageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | nodeAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | nodesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p50IndexingLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p50SearchLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p90IndexingLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p90SearchLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p99IndexingLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p99SearchLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | searchLatencyAlarmFactory | LatencyAlarmFactory | *No description.* | | searchLatencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | title | string | *No description.* | | tpsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | usageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | url | string | *No description.* | --- ##### `automatedSnapshotFailureMetric`^Required ```typescript public readonly automatedSnapshotFailureMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `clusterAlarmFactory`^Required ```typescript public readonly clusterAlarmFactory: OpenSearchClusterAlarmFactory; ``` - *Type:* OpenSearchClusterAlarmFactory --- ##### `clusterAnnotations`^Required ```typescript public readonly clusterAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `clusterStatusRedMetric`^Required ```typescript public readonly clusterStatusRedMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `clusterStatusYellowMetric`^Required ```typescript public readonly clusterStatusYellowMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageMetric`^Required ```typescript public readonly cpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `diskSpaceUsageMetric`^Required ```typescript public readonly diskSpaceUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `indexingLatencyAlarmFactory`^Required ```typescript public readonly indexingLatencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `indexingLatencyAnnotations`^Required ```typescript public readonly indexingLatencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `indexWriteBlockedMetric`^Required ```typescript public readonly indexWriteBlockedMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `jvmMemoryPressureMetric`^Required ```typescript public readonly jvmMemoryPressureMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `kmsKeyErrorMetric`^Required ```typescript public readonly kmsKeyErrorMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `kmsKeyInaccessibleMetric`^Required ```typescript public readonly kmsKeyInaccessibleMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `masterCpuUsageMetric`^Required ```typescript public readonly masterCpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `masterJvmMemoryPressureMetric`^Required ```typescript public readonly masterJvmMemoryPressureMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `masterUsageAnnotations`^Required ```typescript public readonly masterUsageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `nodeAnnotations`^Required ```typescript public readonly nodeAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `nodesMetric`^Required ```typescript public readonly nodesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p50IndexingLatencyMetric`^Required ```typescript public readonly p50IndexingLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p50SearchLatencyMetric`^Required ```typescript public readonly p50SearchLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p90IndexingLatencyMetric`^Required ```typescript public readonly p90IndexingLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p90SearchLatencyMetric`^Required ```typescript public readonly p90SearchLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p99IndexingLatencyMetric`^Required ```typescript public readonly p99IndexingLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p99SearchLatencyMetric`^Required ```typescript public readonly p99SearchLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `searchLatencyAlarmFactory`^Required ```typescript public readonly searchLatencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `searchLatencyAnnotations`^Required ```typescript public readonly searchLatencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `tpsMetric`^Required ```typescript public readonly tpsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `usageAnnotations`^Required ```typescript public readonly usageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string --- ### OpenSearchIngestionPipelineMetricFactory > [https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-pipeline-metrics.html](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-pipeline-metrics.html) #### Initializers ```typescript import { OpenSearchIngestionPipelineMetricFactory } from 'cdk-monitoring-constructs' new OpenSearchIngestionPipelineMetricFactory(metricFactory: MetricFactory, props: OpenSearchIngestionPipelineMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | OpenSearchIngestionPipelineMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* OpenSearchIngestionPipelineMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricDlqS3RecordsCount | *No description.* | | metricDlqS3RecordsFailedCount | *No description.* | | metricDlqS3RecordsSuccessCount | *No description.* | | metricRecordsProcessedCount | *No description.* | | metricSinkBulkPipelineLatencyMax | *No description.* | | metricSinkBulkRequestLatencyMax | *No description.* | | metricSinkRecordsInCount | *No description.* | | metricSourceBytesReceivedSum | *No description.* | --- ##### `metricDlqS3RecordsCount` ```typescript public metricDlqS3RecordsCount(): MathExpression | Metric ``` ##### `metricDlqS3RecordsFailedCount` ```typescript public metricDlqS3RecordsFailedCount(): MathExpression | Metric ``` ##### `metricDlqS3RecordsSuccessCount` ```typescript public metricDlqS3RecordsSuccessCount(): MathExpression | Metric ``` ##### `metricRecordsProcessedCount` ```typescript public metricRecordsProcessedCount(): MathExpression | Metric ``` ##### `metricSinkBulkPipelineLatencyMax` ```typescript public metricSinkBulkPipelineLatencyMax(): MathExpression | Metric ``` ##### `metricSinkBulkRequestLatencyMax` ```typescript public metricSinkBulkRequestLatencyMax(): MathExpression | Metric ``` ##### `metricSinkRecordsInCount` ```typescript public metricSinkRecordsInCount(): MathExpression | Metric ``` ##### `metricSourceBytesReceivedSum` ```typescript public metricSourceBytesReceivedSum(): MathExpression | Metric ``` ### OpenSearchIngestionPipelineMonitoring #### Initializers ```typescript import { OpenSearchIngestionPipelineMonitoring } from 'cdk-monitoring-constructs' new OpenSearchIngestionPipelineMonitoring(scope: MonitoringScope, props: OpenSearchIngestionPipelineMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | OpenSearchIngestionPipelineMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* OpenSearchIngestionPipelineMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | metricDlqS3RecordsCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricSinkBulkPipelineLatencyMax | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricSinkBulkRequestLatencyMax | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricSinkRecordsInCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricSourceBytesReceivedSum | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | usageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | pipelineUrl | string | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `metricDlqS3RecordsCount`^Required ```typescript public readonly metricDlqS3RecordsCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricSinkBulkPipelineLatencyMax`^Required ```typescript public readonly metricSinkBulkPipelineLatencyMax: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricSinkBulkRequestLatencyMax`^Required ```typescript public readonly metricSinkBulkRequestLatencyMax: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricSinkRecordsInCount`^Required ```typescript public readonly metricSinkRecordsInCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricSourceBytesReceivedSum`^Required ```typescript public readonly metricSourceBytesReceivedSum: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `usageAnnotations`^Required ```typescript public readonly usageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `pipelineUrl`^Optional ```typescript public readonly pipelineUrl: string; ``` - *Type:* string --- ### OpenSearchServerlessIndexMetricFactory > [https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-cloudwatch.html](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-cloudwatch.html) #### Initializers ```typescript import { OpenSearchServerlessIndexMetricFactory } from 'cdk-monitoring-constructs' new OpenSearchServerlessIndexMetricFactory(metricFactory: MetricFactory, props: OpenSearchServerlessIndexMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | OpenSearchServerlessIndexMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* OpenSearchServerlessIndexMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricIndexSearchableDocuments | *No description.* | --- ##### `metricIndexSearchableDocuments` ```typescript public metricIndexSearchableDocuments(): MathExpression | Metric ``` ### OpenSearchServerlessIndexMonitoring #### Initializers ```typescript import { OpenSearchServerlessIndexMonitoring } from 'cdk-monitoring-constructs' new OpenSearchServerlessIndexMonitoring(scope: MonitoringScope, props: OpenSearchServerlessIndexMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | OpenSearchServerlessIndexMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* OpenSearchServerlessIndexMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | metricIndexSearchableDocuments | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | --- ##### `metricIndexSearchableDocuments`^Required ```typescript public readonly metricIndexSearchableDocuments: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ### OpenSearchServerlessMetricFactory > [https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-cloudwatch.html](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/monitoring-cloudwatch.html) #### Initializers ```typescript import { OpenSearchServerlessMetricFactory } from 'cdk-monitoring-constructs' new OpenSearchServerlessMetricFactory(metricFactory: MetricFactory, props: OpenSearchServerlessMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | OpenSearchServerlessMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* OpenSearchServerlessMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metric4xxCount | *No description.* | | metric4xxRate | *No description.* | | metric5xxCount | *No description.* | | metric5xxRate | *No description.* | | metricIngestionRequestErrors | *No description.* | | metricIngestionRequestLatency | *No description.* | | metricIngestionRequestSuccess | *No description.* | | metricSearchRequestErrors | *No description.* | | metricSearchRequestLatency | *No description.* | --- ##### `metric4xxCount` ```typescript public metric4xxCount(): MathExpression | Metric ``` ##### `metric4xxRate` ```typescript public metric4xxRate(): MathExpression | Metric ``` ##### `metric5xxCount` ```typescript public metric5xxCount(): MathExpression | Metric ``` ##### `metric5xxRate` ```typescript public metric5xxRate(): MathExpression | Metric ``` ##### `metricIngestionRequestErrors` ```typescript public metricIngestionRequestErrors(): MathExpression | Metric ``` ##### `metricIngestionRequestLatency` ```typescript public metricIngestionRequestLatency(statistic: LatencyType): MathExpression | Metric ``` ###### `statistic`^Required - *Type:* LatencyType --- ##### `metricIngestionRequestSuccess` ```typescript public metricIngestionRequestSuccess(): MathExpression | Metric ``` ##### `metricSearchRequestErrors` ```typescript public metricSearchRequestErrors(): MathExpression | Metric ``` ##### `metricSearchRequestLatency` ```typescript public metricSearchRequestLatency(statistic: LatencyType): MathExpression | Metric ``` ###### `statistic`^Required - *Type:* LatencyType --- ### OpenSearchServerlessMonitoring #### Initializers ```typescript import { OpenSearchServerlessMonitoring } from 'cdk-monitoring-constructs' new OpenSearchServerlessMonitoring(scope: MonitoringScope, props: OpenSearchServerlessMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | OpenSearchServerlessMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* OpenSearchServerlessMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | metric4xxErrorCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metric4xxErrorRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metric5xxErrorCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metric5xxErrorRate | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricIngestionRequestErrorsCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricIngestionRequestLatencyAvg | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricIngestionRequestLatencyMax | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricIngestionRequestSuccessCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricSearchRequestErrorsCount | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricSearchRequestLatencyAvg | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | metricSearchRequestLatencyMax | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | searchLatencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | title | string | *No description.* | | collectionUrl | string | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `metric4xxErrorCount`^Required ```typescript public readonly metric4xxErrorCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metric4xxErrorRate`^Required ```typescript public readonly metric4xxErrorRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metric5xxErrorCount`^Required ```typescript public readonly metric5xxErrorCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metric5xxErrorRate`^Required ```typescript public readonly metric5xxErrorRate: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricIngestionRequestErrorsCount`^Required ```typescript public readonly metricIngestionRequestErrorsCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricIngestionRequestLatencyAvg`^Required ```typescript public readonly metricIngestionRequestLatencyAvg: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricIngestionRequestLatencyMax`^Required ```typescript public readonly metricIngestionRequestLatencyMax: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricIngestionRequestSuccessCount`^Required ```typescript public readonly metricIngestionRequestSuccessCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricSearchRequestErrorsCount`^Required ```typescript public readonly metricSearchRequestErrorsCount: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricSearchRequestLatencyAvg`^Required ```typescript public readonly metricSearchRequestLatencyAvg: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `metricSearchRequestLatencyMax`^Required ```typescript public readonly metricSearchRequestLatencyMax: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `searchLatencyAnnotations`^Required ```typescript public readonly searchLatencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `collectionUrl`^Optional ```typescript public readonly collectionUrl: string; ``` - *Type:* string --- ### OpsItemAlarmActionStrategy - *Implements:* IAlarmActionStrategy Alarm action strategy that creates an AWS OpsCenter OpsItem. #### Initializers ```typescript import { OpsItemAlarmActionStrategy } from 'cdk-monitoring-constructs' new OpsItemAlarmActionStrategy(severity: OpsItemSeverity, category?: OpsItemCategory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | severity | aws-cdk-lib.aws_cloudwatch_actions.OpsItemSeverity | *No description.* | | category | aws-cdk-lib.aws_cloudwatch_actions.OpsItemCategory | *No description.* | --- ##### `severity`^Required - *Type:* aws-cdk-lib.aws_cloudwatch_actions.OpsItemSeverity --- ##### `category`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch_actions.OpsItemCategory --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarmActions | *No description.* | --- ##### `addAlarmActions` ```typescript public addAlarmActions(props: AlarmActionStrategyProps): void ``` ###### `props`^Required - *Type:* AlarmActionStrategyProps --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | severity | aws-cdk-lib.aws_cloudwatch_actions.OpsItemSeverity | OPS Item Severity. | | category | aws-cdk-lib.aws_cloudwatch_actions.OpsItemCategory | OPS Item Category. | --- ##### `severity`^Required ```typescript public readonly severity: OpsItemSeverity; ``` - *Type:* aws-cdk-lib.aws_cloudwatch_actions.OpsItemSeverity OPS Item Severity. --- ##### `category`^Optional ```typescript public readonly category: OpsItemCategory; ``` - *Type:* aws-cdk-lib.aws_cloudwatch_actions.OpsItemCategory OPS Item Category. --- ### QueueAlarmFactory #### Initializers ```typescript import { QueueAlarmFactory } from 'cdk-monitoring-constructs' new QueueAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addMaxQueueIncomingMessagesCountAlarm | *No description.* | | addMaxQueueMessageAgeAlarm | *No description.* | | addMaxQueueMessageCountAlarm | *No description.* | | addMaxQueueTimeToDrainMessagesAlarm | *No description.* | | addMinQueueIncomingMessagesCountAlarm | *No description.* | | addMinQueueMessageCountAlarm | *No description.* | --- ##### `addMaxQueueIncomingMessagesCountAlarm` ```typescript public addMaxQueueIncomingMessagesCountAlarm(metric: MathExpression | Metric, props: MaxIncomingMessagesCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxIncomingMessagesCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxQueueMessageAgeAlarm` ```typescript public addMaxQueueMessageAgeAlarm(metric: MathExpression | Metric, props: MaxMessageAgeThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxMessageAgeThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxQueueMessageCountAlarm` ```typescript public addMaxQueueMessageCountAlarm(metric: MathExpression | Metric, props: MaxMessageCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxMessageCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxQueueTimeToDrainMessagesAlarm` ```typescript public addMaxQueueTimeToDrainMessagesAlarm(metric: MathExpression | Metric, props: MaxTimeToDrainThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxTimeToDrainThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinQueueIncomingMessagesCountAlarm` ```typescript public addMinQueueIncomingMessagesCountAlarm(metric: MathExpression | Metric, props: MinIncomingMessagesCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinIncomingMessagesCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinQueueMessageCountAlarm` ```typescript public addMinQueueMessageCountAlarm(metric: MathExpression | Metric, props: MinMessageCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinMessageCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### RdsClusterMetricFactory #### Initializers ```typescript import { RdsClusterMetricFactory } from 'cdk-monitoring-constructs' new RdsClusterMetricFactory(metricFactory: MetricFactory, props: RdsClusterMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | RdsClusterMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* RdsClusterMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAverageCpuUsageInPercent | *No description.* | | metricCommitLatencyInMillis | *No description.* | | metricCommitLatencyP90InMillis | *No description.* | | metricDeleteLatencyInMillis | *No description.* | | metricDeleteLatencyP90InMillis | *No description.* | | metricDiskSpaceUsageInPercent | *No description.* | | metricFreeStorageInBytes | *No description.* | | metricInsertLatencyInMillis | *No description.* | | metricInsertLatencyP90InMillis | *No description.* | | metricReadIOPS | *No description.* | | metricSelectLatencyInMillis | *No description.* | | metricSelectLatencyP90InMillis | *No description.* | | metricServerlessDatabaseCapacity | *No description.* | | metricTotalConnectionCount | *No description.* | | metricUpdateLatencyInMillis | *No description.* | | metricUpdateLatencyP90InMillis | *No description.* | | metricUsedStorageInBytes | *No description.* | | metricWriteIOPS | *No description.* | --- ##### `metricAverageCpuUsageInPercent` ```typescript public metricAverageCpuUsageInPercent(): MathExpression | Metric ``` ##### `metricCommitLatencyInMillis` ```typescript public metricCommitLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricCommitLatencyP90InMillis` ```typescript public metricCommitLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricDeleteLatencyInMillis` ```typescript public metricDeleteLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricDeleteLatencyP90InMillis` ```typescript public metricDeleteLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricDiskSpaceUsageInPercent` ```typescript public metricDiskSpaceUsageInPercent(): MathExpression | Metric ``` ##### `metricFreeStorageInBytes` ```typescript public metricFreeStorageInBytes(): MathExpression | Metric ``` ##### `metricInsertLatencyInMillis` ```typescript public metricInsertLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricInsertLatencyP90InMillis` ```typescript public metricInsertLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricReadIOPS` ```typescript public metricReadIOPS(): MathExpression | Metric ``` ##### `metricSelectLatencyInMillis` ```typescript public metricSelectLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricSelectLatencyP90InMillis` ```typescript public metricSelectLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricServerlessDatabaseCapacity` ```typescript public metricServerlessDatabaseCapacity(): MathExpression | Metric ``` ##### `metricTotalConnectionCount` ```typescript public metricTotalConnectionCount(): MathExpression | Metric ``` ##### `metricUpdateLatencyInMillis` ```typescript public metricUpdateLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricUpdateLatencyP90InMillis` ```typescript public metricUpdateLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricUsedStorageInBytes` ```typescript public metricUsedStorageInBytes(): MathExpression | Metric ``` ##### `metricWriteIOPS` ```typescript public metricWriteIOPS(): MathExpression | Metric ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | clusterIdentifier | string | *No description.* | | cluster | aws-cdk-lib.aws_rds.IDatabaseCluster \| aws-cdk-lib.aws_rds.ServerlessCluster | *No description.* | --- ##### `clusterIdentifier`^Required ```typescript public readonly clusterIdentifier: string; ``` - *Type:* string --- ##### `cluster`^Optional ```typescript public readonly cluster: IDatabaseCluster | ServerlessCluster; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseCluster | aws-cdk-lib.aws_rds.ServerlessCluster --- ### RdsClusterMonitoring #### Initializers ```typescript import { RdsClusterMonitoring } from 'cdk-monitoring-constructs' new RdsClusterMonitoring(scope: MonitoringScope, props: RdsClusterMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | RdsClusterMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* RdsClusterMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createConnectionsWidget | *No description.* | | createCpuAndDiskUsageWidget | *No description.* | | createIOPSWidget | *No description.* | | createLatencyWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createConnectionsWidget` ```typescript public createConnectionsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createCpuAndDiskUsageWidget` ```typescript public createCpuAndDiskUsageWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createIOPSWidget` ```typescript public createIOPSWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | commitLatencyMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric} | *No description.* | | connectionAlarmFactory | ConnectionAlarmFactory | *No description.* | | connectionAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | connectionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | deleteLatencyMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric} | *No description.* | | diskSpaceUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | insertLatencyMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric} | *No description.* | | iopsAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | latencyTypesToRender | string[] | *No description.* | | readIopsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | readLatencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | selectLatencyMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric} | *No description.* | | title | string | *No description.* | | updateLatencyMetrics | {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric} | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | usageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | writeIopsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | writeLatencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | url | string | *No description.* | --- ##### `commitLatencyMetrics`^Required ```typescript public readonly commitLatencyMetrics: {[ key: string ]: MathExpression | Metric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric} --- ##### `connectionAlarmFactory`^Required ```typescript public readonly connectionAlarmFactory: ConnectionAlarmFactory; ``` - *Type:* ConnectionAlarmFactory --- ##### `connectionAnnotations`^Required ```typescript public readonly connectionAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `connectionsMetric`^Required ```typescript public readonly connectionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageMetric`^Required ```typescript public readonly cpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `deleteLatencyMetrics`^Required ```typescript public readonly deleteLatencyMetrics: {[ key: string ]: MathExpression | Metric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric} --- ##### `diskSpaceUsageMetric`^Required ```typescript public readonly diskSpaceUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `insertLatencyMetrics`^Required ```typescript public readonly insertLatencyMetrics: {[ key: string ]: MathExpression | Metric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric} --- ##### `iopsAnnotations`^Required ```typescript public readonly iopsAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `latencyTypesToRender`^Required ```typescript public readonly latencyTypesToRender: string[]; ``` - *Type:* string[] --- ##### `readIopsMetric`^Required ```typescript public readonly readIopsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `readLatencyAnnotations`^Required ```typescript public readonly readLatencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `selectLatencyMetrics`^Required ```typescript public readonly selectLatencyMetrics: {[ key: string ]: MathExpression | Metric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric} --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `updateLatencyMetrics`^Required ```typescript public readonly updateLatencyMetrics: {[ key: string ]: MathExpression | Metric}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric} --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `usageAnnotations`^Required ```typescript public readonly usageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `writeIopsMetric`^Required ```typescript public readonly writeIopsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `writeLatencyAnnotations`^Required ```typescript public readonly writeLatencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string --- ### RdsInstanceMetricFactory #### Initializers ```typescript import { RdsInstanceMetricFactory } from 'cdk-monitoring-constructs' new RdsInstanceMetricFactory(metricFactory: MetricFactory, props: RdsInstanceMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | RdsInstanceMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* RdsInstanceMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAverageCpuUsageInPercent | *No description.* | | metricAverageFreeableMemory | *No description.* | | metricMaxFreeStorageSpace | *No description.* | | metricReadIops | *No description.* | | metricReadLatencyInMillis | *No description.* | | metricReadThroughput | *No description.* | | metricTotalConnectionCount | *No description.* | | metricWriteIops | *No description.* | | metricWriteLatencyInMillis | *No description.* | | metricWriteThroughput | *No description.* | --- ##### `metricAverageCpuUsageInPercent` ```typescript public metricAverageCpuUsageInPercent(): MathExpression | Metric ``` ##### `metricAverageFreeableMemory` ```typescript public metricAverageFreeableMemory(): MathExpression | Metric ``` ##### `metricMaxFreeStorageSpace` ```typescript public metricMaxFreeStorageSpace(): MathExpression | Metric ``` ##### `metricReadIops` ```typescript public metricReadIops(): MathExpression | Metric ``` ##### `metricReadLatencyInMillis` ```typescript public metricReadLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricReadThroughput` ```typescript public metricReadThroughput(): MathExpression | Metric ``` ##### `metricTotalConnectionCount` ```typescript public metricTotalConnectionCount(): MathExpression | Metric ``` ##### `metricWriteIops` ```typescript public metricWriteIops(): MathExpression | Metric ``` ##### `metricWriteLatencyInMillis` ```typescript public metricWriteLatencyInMillis(latencyType: LatencyType): MathExpression | Metric ``` ###### `latencyType`^Required - *Type:* LatencyType --- ##### `metricWriteThroughput` ```typescript public metricWriteThroughput(): MathExpression | Metric ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instance | aws-cdk-lib.aws_rds.IDatabaseInstance | *No description.* | | instanceIdentifier | string | *No description.* | --- ##### `instance`^Required ```typescript public readonly instance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance --- ##### `instanceIdentifier`^Required ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string --- ### RdsInstanceMonitoring #### Initializers ```typescript import { RdsInstanceMonitoring } from 'cdk-monitoring-constructs' new RdsInstanceMonitoring(scope: MonitoringScope, props: RdsInstanceMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | RdsInstanceMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* RdsInstanceMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createConnectionsWidget | *No description.* | | createCpuAndDiskUsageWidget | *No description.* | | createLatencyWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createConnectionsWidget` ```typescript public createConnectionsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createCpuAndDiskUsageWidget` ```typescript public createCpuAndDiskUsageWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectionAlarmFactory | ConnectionAlarmFactory | *No description.* | | connectionAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | connectionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | freeableMemoryMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | freeStorageSpaceMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | readIopsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | readLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | readThroughputMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | usageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | writeIopsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | writeLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | writeThroughputMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | url | string | *No description.* | --- ##### `connectionAlarmFactory`^Required ```typescript public readonly connectionAlarmFactory: ConnectionAlarmFactory; ``` - *Type:* ConnectionAlarmFactory --- ##### `connectionAnnotations`^Required ```typescript public readonly connectionAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `connectionsMetric`^Required ```typescript public readonly connectionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageMetric`^Required ```typescript public readonly cpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `freeableMemoryMetric`^Required ```typescript public readonly freeableMemoryMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `freeStorageSpaceMetric`^Required ```typescript public readonly freeStorageSpaceMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `readIopsMetric`^Required ```typescript public readonly readIopsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `readLatencyMetric`^Required ```typescript public readonly readLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `readThroughputMetric`^Required ```typescript public readonly readThroughputMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `usageAnnotations`^Required ```typescript public readonly usageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `writeIopsMetric`^Required ```typescript public readonly writeIopsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `writeLatencyMetric`^Required ```typescript public readonly writeLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `writeThroughputMetric`^Required ```typescript public readonly writeThroughputMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string --- ### RedshiftClusterMetricFactory #### Initializers ```typescript import { RedshiftClusterMetricFactory } from 'cdk-monitoring-constructs' new RedshiftClusterMetricFactory(metricFactory: MetricFactory, props: RedshiftClusterMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | RedshiftClusterMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* RedshiftClusterMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAverageCpuUsageInPercent | *No description.* | | metricAverageDiskSpaceUsageInPercent | *No description.* | | metricLongQueryDurationP90InMillis | *No description.* | | metricMaintenanceModeEnabled | *No description.* | | metricMediumQueryDurationP90InMillis | *No description.* | | metricReadLatencyP90InMillis | *No description.* | | metricShortQueryDurationP90InMillis | *No description.* | | metricTotalConnectionCount | *No description.* | | metricWriteLatencyP90InMillis | *No description.* | --- ##### `metricAverageCpuUsageInPercent` ```typescript public metricAverageCpuUsageInPercent(): MathExpression | Metric ``` ##### `metricAverageDiskSpaceUsageInPercent` ```typescript public metricAverageDiskSpaceUsageInPercent(): MathExpression | Metric ``` ##### `metricLongQueryDurationP90InMillis` ```typescript public metricLongQueryDurationP90InMillis(): MathExpression | Metric ``` ##### `metricMaintenanceModeEnabled` ```typescript public metricMaintenanceModeEnabled(): MathExpression | Metric ``` ##### `metricMediumQueryDurationP90InMillis` ```typescript public metricMediumQueryDurationP90InMillis(): MathExpression | Metric ``` ##### `metricReadLatencyP90InMillis` ```typescript public metricReadLatencyP90InMillis(): MathExpression | Metric ``` ##### `metricShortQueryDurationP90InMillis` ```typescript public metricShortQueryDurationP90InMillis(): MathExpression | Metric ``` ##### `metricTotalConnectionCount` ```typescript public metricTotalConnectionCount(): MathExpression | Metric ``` ##### `metricWriteLatencyP90InMillis` ```typescript public metricWriteLatencyP90InMillis(): MathExpression | Metric ``` ### RedshiftClusterMonitoring #### Initializers ```typescript import { RedshiftClusterMonitoring } from 'cdk-monitoring-constructs' new RedshiftClusterMonitoring(scope: MonitoringScope, props: RedshiftClusterMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | RedshiftClusterMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* RedshiftClusterMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createConnectionsWidget | *No description.* | | createCpuAndDiskUsageWidget | *No description.* | | createLatencyWidget | *No description.* | | createMaintenanceWidget | *No description.* | | createQueryDurationWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createConnectionsWidget` ```typescript public createConnectionsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createCpuAndDiskUsageWidget` ```typescript public createCpuAndDiskUsageWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMaintenanceWidget` ```typescript public createMaintenanceWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createQueryDurationWidget` ```typescript public createQueryDurationWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | connectionAlarmFactory | ConnectionAlarmFactory | *No description.* | | connectionAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | connectionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | cpuUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | diskSpaceUsageMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | longQueryDurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | maintenanceModeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | mediumQueryDurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | queryDurationAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | readLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | shortQueryDurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | usageAlarmFactory | UsageAlarmFactory | *No description.* | | usageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | writeLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | url | string | *No description.* | --- ##### `connectionAlarmFactory`^Required ```typescript public readonly connectionAlarmFactory: ConnectionAlarmFactory; ``` - *Type:* ConnectionAlarmFactory --- ##### `connectionAnnotations`^Required ```typescript public readonly connectionAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `connectionsMetric`^Required ```typescript public readonly connectionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `cpuUsageMetric`^Required ```typescript public readonly cpuUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `diskSpaceUsageMetric`^Required ```typescript public readonly diskSpaceUsageMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `longQueryDurationMetric`^Required ```typescript public readonly longQueryDurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `maintenanceModeMetric`^Required ```typescript public readonly maintenanceModeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `mediumQueryDurationMetric`^Required ```typescript public readonly mediumQueryDurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `queryDurationAnnotations`^Required ```typescript public readonly queryDurationAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `readLatencyMetric`^Required ```typescript public readonly readLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `shortQueryDurationMetric`^Required ```typescript public readonly shortQueryDurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `usageAlarmFactory`^Required ```typescript public readonly usageAlarmFactory: UsageAlarmFactory; ``` - *Type:* UsageAlarmFactory --- ##### `usageAnnotations`^Required ```typescript public readonly usageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `writeLatencyMetric`^Required ```typescript public readonly writeLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `url`^Optional ```typescript public readonly url: string; ``` - *Type:* string --- ### Route53HealthCheckMetricAdjuster - *Implements:* IMetricAdjuster Adjusts a metric so that alarms created from it can be used in Route53 Health Checks. The metric will be validated to ensure it satisfies Route53 Health Check alarm requirements, otherwise it will throw an {@link Error}. > [https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-types.html](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-types.html) #### Initializers ```typescript import { Route53HealthCheckMetricAdjuster } from 'cdk-monitoring-constructs' new Route53HealthCheckMetricAdjuster() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | adjustMetric | Adjusts a metric. | --- ##### `adjustMetric` ```typescript public adjustMetric(metric: MathExpression | Metric, alarmScope: Construct, props: AddAlarmProps): MathExpression | Metric ``` Adjusts a metric. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `alarmScope`^Required - *Type:* constructs.Construct --- ###### `props`^Required - *Type:* AddAlarmProps --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | INSTANCE | Route53HealthCheckMetricAdjuster | *No description.* | --- ##### `INSTANCE`^Required ```typescript public readonly INSTANCE: Route53HealthCheckMetricAdjuster; ``` - *Type:* Route53HealthCheckMetricAdjuster --- ### S3BucketMetricFactory #### Initializers ```typescript import { S3BucketMetricFactory } from 'cdk-monitoring-constructs' new S3BucketMetricFactory(metricFactory: MetricFactory, props: S3BucketMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | S3BucketMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* S3BucketMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricBucketSizeBytes | *No description.* | | metricNumberOfObjects | *No description.* | --- ##### `metricBucketSizeBytes` ```typescript public metricBucketSizeBytes(): MathExpression | Metric ``` ##### `metricNumberOfObjects` ```typescript public metricNumberOfObjects(): MathExpression | Metric ``` ### S3BucketMonitoring #### Initializers ```typescript import { S3BucketMonitoring } from 'cdk-monitoring-constructs' new S3BucketMonitoring(scope: MonitoringScope, props: S3BucketMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | S3BucketMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* S3BucketMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ### SecretsManagerAlarmFactory #### Initializers ```typescript import { SecretsManagerAlarmFactory } from 'cdk-monitoring-constructs' new SecretsManagerAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addChangeInSecretCountAlarm | *No description.* | | addMaxSecretCountAlarm | *No description.* | | addMinSecretCountAlarm | *No description.* | --- ##### `addChangeInSecretCountAlarm` ```typescript public addChangeInSecretCountAlarm(metric: MathExpression | Metric, props: ChangeInSecretCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* ChangeInSecretCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxSecretCountAlarm` ```typescript public addMaxSecretCountAlarm(metric: MathExpression | Metric, props: MaxSecretCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxSecretCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinSecretCountAlarm` ```typescript public addMinSecretCountAlarm(metric: MathExpression | Metric, props: MinSecretCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinSecretCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### SecretsManagerMetricFactory #### Initializers ```typescript import { SecretsManagerMetricFactory } from 'cdk-monitoring-constructs' new SecretsManagerMetricFactory(metricFactory: MetricFactory, props: BaseMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | BaseMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* BaseMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricSecretCount | *No description.* | --- ##### `metricSecretCount` ```typescript public metricSecretCount(): MathExpression | Metric ``` ### SecretsManagerMonitoring #### Initializers ```typescript import { SecretsManagerMonitoring } from 'cdk-monitoring-constructs' new SecretsManagerMonitoring(scope: MonitoringScope, props: SecretsManagerMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | SecretsManagerMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* SecretsManagerMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createSecretsCountWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createSecretsCountWidget` ```typescript public createSecretsCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | secretsCountAnnotation | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | secretsCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | secretsManagerAlarmFactory | SecretsManagerAlarmFactory | *No description.* | | title | string | *No description.* | --- ##### `secretsCountAnnotation`^Required ```typescript public readonly secretsCountAnnotation: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `secretsCountMetric`^Required ```typescript public readonly secretsCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `secretsManagerAlarmFactory`^Required ```typescript public readonly secretsManagerAlarmFactory: SecretsManagerAlarmFactory; ``` - *Type:* SecretsManagerAlarmFactory --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ### SecretsManagerSecretMetricFactory #### Initializers ```typescript import { SecretsManagerSecretMetricFactory } from 'cdk-monitoring-constructs' new SecretsManagerSecretMetricFactory(metricFactory: MetricFactory, props: SecretsManagerSecretMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | SecretsManagerSecretMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* SecretsManagerSecretMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricDaysSinceLastChange | *No description.* | | metricDaysSinceLastRotation | *No description.* | --- ##### `metricDaysSinceLastChange` ```typescript public metricDaysSinceLastChange(): MathExpression | Metric ``` ##### `metricDaysSinceLastRotation` ```typescript public metricDaysSinceLastRotation(): MathExpression | Metric ``` #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | MetricNameDaysSinceLastChange | string | *No description.* | | MetricNameDaysSinceLastRotation | string | *No description.* | | Namespace | string | *No description.* | --- ##### `MetricNameDaysSinceLastChange`^Required ```typescript public readonly MetricNameDaysSinceLastChange: string; ``` - *Type:* string --- ##### `MetricNameDaysSinceLastRotation`^Required ```typescript public readonly MetricNameDaysSinceLastRotation: string; ``` - *Type:* string --- ##### `Namespace`^Required ```typescript public readonly Namespace: string; ``` - *Type:* string --- ### SecretsManagerSecretMonitoring #### Initializers ```typescript import { SecretsManagerSecretMonitoring } from 'cdk-monitoring-constructs' new SecretsManagerSecretMonitoring(scope: MonitoringScope, props: SecretsManagerSecretMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | SecretsManagerSecretMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* SecretsManagerSecretMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createDaysSinceLastChangeWidget | *No description.* | | createDaysSinceLastRotationWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createDaysSinceLastChangeWidget` ```typescript public createDaysSinceLastChangeWidget(): GraphWidget ``` ##### `createDaysSinceLastRotationWidget` ```typescript public createDaysSinceLastRotationWidget(): GraphWidget ``` ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | daysSinceLastChangeAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | daysSinceLastChangeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | daysSinceLastRotationAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | daysSinceLastRotationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | showLastRotationWidget | boolean | *No description.* | | title | string | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `daysSinceLastChangeAnnotations`^Required ```typescript public readonly daysSinceLastChangeAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `daysSinceLastChangeMetric`^Required ```typescript public readonly daysSinceLastChangeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `daysSinceLastRotationAnnotations`^Required ```typescript public readonly daysSinceLastRotationAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `daysSinceLastRotationMetric`^Required ```typescript public readonly daysSinceLastRotationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `showLastRotationWidget`^Required ```typescript public readonly showLastRotationWidget: boolean; ``` - *Type:* boolean --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ### SingleAxisGraphWidget Line graph widget with one axis only (left). If there is just one metric, it will hide the legend to save space. The purpose of this custom class is to make the properties more strict. It will avoid graphs with undefined axis and dimensions. #### Initializers ```typescript import { SingleAxisGraphWidget } from 'cdk-monitoring-constructs' new SingleAxisGraphWidget(props: SingleAxisGraphWidgetProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SingleAxisGraphWidgetProps | *No description.* | --- ##### `props`^Required - *Type:* SingleAxisGraphWidgetProps --- #### Methods | **Name** | **Description** | | --- | --- | | position | Place the widget at a given position. | | toJson | Return the widget JSON for use in the dashboard. | | addLeftMetric | Add another metric to the left Y axis of the GraphWidget. | | addRightMetric | Add another metric to the right Y axis of the GraphWidget. | --- ##### `position` ```typescript public position(x: number, y: number): void ``` Place the widget at a given position. ###### `x`^Required - *Type:* number --- ###### `y`^Required - *Type:* number --- ##### `toJson` ```typescript public toJson(): any[] ``` Return the widget JSON for use in the dashboard. ##### `addLeftMetric` ```typescript public addLeftMetric(metric: IMetric): void ``` Add another metric to the left Y axis of the GraphWidget. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric the metric to add. --- ##### `addRightMetric` ```typescript public addRightMetric(metric: IMetric): void ``` Add another metric to the right Y axis of the GraphWidget. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric the metric to add. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | height | number | The amount of vertical grid units the widget will take up. | | width | number | The amount of horizontal grid units the widget will take up. | | warnings | string[] | Any warnings that are produced as a result of putting together this widget. | | warningsV2 | {[ key: string ]: string} | Any warnings that are produced as a result of putting together this widget. | --- ##### `height`^Required ```typescript public readonly height: number; ``` - *Type:* number The amount of vertical grid units the widget will take up. --- ##### `width`^Required ```typescript public readonly width: number; ``` - *Type:* number The amount of horizontal grid units the widget will take up. --- ##### `warnings`^Optional ```typescript public readonly warnings: string[]; ``` - *Type:* string[] Any warnings that are produced as a result of putting together this widget. --- ##### `warningsV2`^Optional ```typescript public readonly warningsV2: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} Any warnings that are produced as a result of putting together this widget. --- ### SingleWidgetDashboardSegment - *Implements:* IDashboardSegment, IDynamicDashboardSegment #### Initializers ```typescript import { SingleWidgetDashboardSegment } from 'cdk-monitoring-constructs' new SingleWidgetDashboardSegment(widget: IWidget, dashboardsToInclude?: string[]) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | widget | aws-cdk-lib.aws_cloudwatch.IWidget | widget to add. | | dashboardsToInclude | string[] | list of dashboard names which to show this widget on. | --- ##### `widget`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.IWidget widget to add. --- ##### `dashboardsToInclude`^Optional - *Type:* string[] list of dashboard names which to show this widget on. Defaults to the default dashboards. --- #### Methods | **Name** | **Description** | | --- | --- | | alarmWidgets | Returns widgets for all alarms. | | summaryWidgets | Returns widgets for the summary. | | widgets | Returns all widgets. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These should go to the runbook or service dashboard. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets for the summary. These should go to the team OPS dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns all widgets. These should go to the detailed service dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ### SnsAlarmActionStrategy - *Implements:* IAlarmActionStrategy Alarm action strategy that sends a notification to the specified SNS topic. #### Initializers ```typescript import { SnsAlarmActionStrategy } from 'cdk-monitoring-constructs' new SnsAlarmActionStrategy(props: SnsAlarmActionStrategyProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SnsAlarmActionStrategyProps | *No description.* | --- ##### `props`^Required - *Type:* SnsAlarmActionStrategyProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarmActions | *No description.* | --- ##### `addAlarmActions` ```typescript public addAlarmActions(props: AlarmActionStrategyProps): void ``` ###### `props`^Required - *Type:* AlarmActionStrategyProps --- ### SnsTopicMetricFactory #### Initializers ```typescript import { SnsTopicMetricFactory } from 'cdk-monitoring-constructs' new SnsTopicMetricFactory(metricFactory: MetricFactory, props: SnsTopicMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | SnsTopicMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* SnsTopicMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAverageMessageSizeInBytes | *No description.* | | metricIncomingMessageCount | *No description.* | | metricNumberOfNotificationsFailed | *No description.* | | metricOutgoingMessageCount | *No description.* | --- ##### `metricAverageMessageSizeInBytes` ```typescript public metricAverageMessageSizeInBytes(): MathExpression | Metric ``` ##### `metricIncomingMessageCount` ```typescript public metricIncomingMessageCount(): MathExpression | Metric ``` ##### `metricNumberOfNotificationsFailed` ```typescript public metricNumberOfNotificationsFailed(): MathExpression | Metric ``` ##### `metricOutgoingMessageCount` ```typescript public metricOutgoingMessageCount(): MathExpression | Metric ``` ### SnsTopicMonitoring #### Initializers ```typescript import { SnsTopicMonitoring } from 'cdk-monitoring-constructs' new SnsTopicMonitoring(scope: MonitoringScope, props: SnsTopicMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | SnsTopicMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* SnsTopicMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createMessageCountWidget | *No description.* | | createMessageFailedWidget | *No description.* | | createMessageSizeWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createMessageCountWidget` ```typescript public createMessageCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMessageFailedWidget` ```typescript public createMessageFailedWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMessageSizeWidget` ```typescript public createMessageSizeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | failedDeliveryAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | incomingMessagesAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | incomingMessagesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | messagesFailedMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | messageSizeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | outgoingMessagesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | topicAlarmFactory | TopicAlarmFactory | *No description.* | | topicUrl | string | *No description.* | --- ##### `failedDeliveryAnnotations`^Required ```typescript public readonly failedDeliveryAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `incomingMessagesAnnotations`^Required ```typescript public readonly incomingMessagesAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `incomingMessagesMetric`^Required ```typescript public readonly incomingMessagesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `messagesFailedMetric`^Required ```typescript public readonly messagesFailedMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `messageSizeMetric`^Required ```typescript public readonly messageSizeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `outgoingMessagesMetric`^Required ```typescript public readonly outgoingMessagesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `topicAlarmFactory`^Required ```typescript public readonly topicAlarmFactory: TopicAlarmFactory; ``` - *Type:* TopicAlarmFactory --- ##### `topicUrl`^Optional ```typescript public readonly topicUrl: string; ``` - *Type:* string --- ### SqsQueueMetricFactory #### Initializers ```typescript import { SqsQueueMetricFactory } from 'cdk-monitoring-constructs' new SqsQueueMetricFactory(metricFactory: MetricFactory, props: SqsQueueMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | SqsQueueMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* SqsQueueMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricApproximateAgeOfOldestMessageInSeconds | *No description.* | | metricApproximateVisibleMessageCount | *No description.* | | metricAverageMessageSizeInBytes | *No description.* | | metricConsumptionRate | *No description.* | | metricDeletedMessageCount | *No description.* | | metricIncomingMessageCount | *No description.* | | metricProductionRate | *No description.* | | metricTimeToDrain | *No description.* | --- ##### `metricApproximateAgeOfOldestMessageInSeconds` ```typescript public metricApproximateAgeOfOldestMessageInSeconds(): MathExpression | Metric ``` ##### `metricApproximateVisibleMessageCount` ```typescript public metricApproximateVisibleMessageCount(): MathExpression | Metric ``` ##### `metricAverageMessageSizeInBytes` ```typescript public metricAverageMessageSizeInBytes(): MathExpression | Metric ``` ##### `metricConsumptionRate` ```typescript public metricConsumptionRate(): MathExpression | Metric ``` ##### `metricDeletedMessageCount` ```typescript public metricDeletedMessageCount(): MathExpression | Metric ``` ##### `metricIncomingMessageCount` ```typescript public metricIncomingMessageCount(): MathExpression | Metric ``` ##### `metricProductionRate` ```typescript public metricProductionRate(): MathExpression | Metric ``` ##### `metricTimeToDrain` ```typescript public metricTimeToDrain(): MathExpression | Metric ``` ### SqsQueueMonitoring #### Initializers ```typescript import { SqsQueueMonitoring } from 'cdk-monitoring-constructs' new SqsQueueMonitoring(scope: MonitoringScope, props: SqsQueueMonitoringProps, invokedFromSuper?: boolean) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | SqsQueueMonitoringProps | *No description.* | | invokedFromSuper | boolean | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* SqsQueueMonitoringProps --- ##### `invokedFromSuper`^Optional - *Type:* boolean --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createMessageAgeWidget | *No description.* | | createMessageCountWidget | *No description.* | | createMessageSizeWidget | *No description.* | | createProducerAndConsumerRateWidget | *No description.* | | createTimeToDrainWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createMessageAgeWidget` ```typescript public createMessageAgeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMessageCountWidget` ```typescript public createMessageCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMessageSizeWidget` ```typescript public createMessageSizeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createProducerAndConsumerRateWidget` ```typescript public createProducerAndConsumerRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTimeToDrainWidget` ```typescript public createTimeToDrainWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | consumptionRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | countAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | deletedMessagesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | incomingMessagesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | messageSizeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | oldestMessageAgeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | productionRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | queueAlarmFactory | QueueAlarmFactory | *No description.* | | timeToDrainAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | timeToDrainMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | visibleMessagesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | queueUrl | string | *No description.* | --- ##### `ageAnnotations`^Required ```typescript public readonly ageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `consumptionRateMetric`^Required ```typescript public readonly consumptionRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `countAnnotations`^Required ```typescript public readonly countAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `deletedMessagesMetric`^Required ```typescript public readonly deletedMessagesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `incomingMessagesMetric`^Required ```typescript public readonly incomingMessagesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `messageSizeMetric`^Required ```typescript public readonly messageSizeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `oldestMessageAgeMetric`^Required ```typescript public readonly oldestMessageAgeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `productionRateMetric`^Required ```typescript public readonly productionRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `queueAlarmFactory`^Required ```typescript public readonly queueAlarmFactory: QueueAlarmFactory; ``` - *Type:* QueueAlarmFactory --- ##### `timeToDrainAnnotations`^Required ```typescript public readonly timeToDrainAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `timeToDrainMetric`^Required ```typescript public readonly timeToDrainMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `visibleMessagesMetric`^Required ```typescript public readonly visibleMessagesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `queueUrl`^Optional ```typescript public readonly queueUrl: string; ``` - *Type:* string --- ### SqsQueueMonitoringWithDlq #### Initializers ```typescript import { SqsQueueMonitoringWithDlq } from 'cdk-monitoring-constructs' new SqsQueueMonitoringWithDlq(scope: MonitoringScope, props: SqsQueueMonitoringWithDlqProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | SqsQueueMonitoringWithDlqProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* SqsQueueMonitoringWithDlqProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createMessageAgeWidget | *No description.* | | createMessageCountWidget | *No description.* | | createMessageSizeWidget | *No description.* | | createProducerAndConsumerRateWidget | *No description.* | | createTimeToDrainWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createMessageAgeWidget` ```typescript public createMessageAgeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMessageCountWidget` ```typescript public createMessageCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createMessageSizeWidget` ```typescript public createMessageSizeWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createProducerAndConsumerRateWidget` ```typescript public createProducerAndConsumerRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTimeToDrainWidget` ```typescript public createTimeToDrainWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | ageAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | consumptionRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | countAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | deletedMessagesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | incomingMessagesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | messageSizeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | oldestMessageAgeMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | productionRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | queueAlarmFactory | QueueAlarmFactory | *No description.* | | timeToDrainAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | timeToDrainMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | visibleMessagesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | queueUrl | string | *No description.* | --- ##### `ageAnnotations`^Required ```typescript public readonly ageAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `consumptionRateMetric`^Required ```typescript public readonly consumptionRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `countAnnotations`^Required ```typescript public readonly countAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `deletedMessagesMetric`^Required ```typescript public readonly deletedMessagesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `incomingMessagesMetric`^Required ```typescript public readonly incomingMessagesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `messageSizeMetric`^Required ```typescript public readonly messageSizeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `oldestMessageAgeMetric`^Required ```typescript public readonly oldestMessageAgeMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `productionRateMetric`^Required ```typescript public readonly productionRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `queueAlarmFactory`^Required ```typescript public readonly queueAlarmFactory: QueueAlarmFactory; ``` - *Type:* QueueAlarmFactory --- ##### `timeToDrainAnnotations`^Required ```typescript public readonly timeToDrainAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `timeToDrainMetric`^Required ```typescript public readonly timeToDrainMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `visibleMessagesMetric`^Required ```typescript public readonly visibleMessagesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `queueUrl`^Optional ```typescript public readonly queueUrl: string; ``` - *Type:* string --- ### StaticSegmentDynamicAdapter - *Implements:* IDynamicDashboardSegment #### Initializers ```typescript import { StaticSegmentDynamicAdapter } from 'cdk-monitoring-constructs' new StaticSegmentDynamicAdapter(props: IDashboardFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | IDashboardFactoryProps | *No description.* | --- ##### `props`^Required - *Type:* IDashboardFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | widgetsForDashboard | Adapts an IDashboardSegment to the IDynamicDashboardSegment interface by using overrideProps to determine if a segment should be shown on a specific dashboard. | --- ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Adapts an IDashboardSegment to the IDynamicDashboardSegment interface by using overrideProps to determine if a segment should be shown on a specific dashboard. The default values are true, so consumers must set these to false if they would like to hide these items from dashboards ###### `name`^Required - *Type:* string --- ### StepFunctionActivityMetricFactory #### Initializers ```typescript import { StepFunctionActivityMetricFactory } from 'cdk-monitoring-constructs' new StepFunctionActivityMetricFactory(metricFactory: MetricFactory, props: StepFunctionActivityMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | StepFunctionActivityMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* StepFunctionActivityMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricActivitiesFailed | *No description.* | | metricActivitiesFailedRate | *No description.* | | metricActivitiesHeartbeatTimedOut | *No description.* | | metricActivitiesScheduled | *No description.* | | metricActivitiesStarted | *No description.* | | metricActivitiesSucceeded | *No description.* | | metricActivitiesTimedOut | *No description.* | | metricActivityRunTimeP50InMillis | *No description.* | | metricActivityRunTimeP90InMillis | *No description.* | | metricActivityRunTimeP99InMillis | *No description.* | | metricActivityScheduleTimeP50InMillis | *No description.* | | metricActivityScheduleTimeP90InMillis | *No description.* | | metricActivityScheduleTimeP99InMillis | *No description.* | | metricActivityTimeP50InMillis | *No description.* | | metricActivityTimeP90InMillis | *No description.* | | metricActivityTimeP99InMillis | *No description.* | --- ##### `metricActivitiesFailed` ```typescript public metricActivitiesFailed(): MathExpression | Metric ``` ##### `metricActivitiesFailedRate` ```typescript public metricActivitiesFailedRate(): MathExpression | Metric ``` ##### `metricActivitiesHeartbeatTimedOut` ```typescript public metricActivitiesHeartbeatTimedOut(): MathExpression | Metric ``` ##### `metricActivitiesScheduled` ```typescript public metricActivitiesScheduled(): MathExpression | Metric ``` ##### `metricActivitiesStarted` ```typescript public metricActivitiesStarted(): MathExpression | Metric ``` ##### `metricActivitiesSucceeded` ```typescript public metricActivitiesSucceeded(): MathExpression | Metric ``` ##### `metricActivitiesTimedOut` ```typescript public metricActivitiesTimedOut(): MathExpression | Metric ``` ##### `metricActivityRunTimeP50InMillis` ```typescript public metricActivityRunTimeP50InMillis(): MathExpression | Metric ``` ##### `metricActivityRunTimeP90InMillis` ```typescript public metricActivityRunTimeP90InMillis(): MathExpression | Metric ``` ##### `metricActivityRunTimeP99InMillis` ```typescript public metricActivityRunTimeP99InMillis(): MathExpression | Metric ``` ##### `metricActivityScheduleTimeP50InMillis` ```typescript public metricActivityScheduleTimeP50InMillis(): MathExpression | Metric ``` ##### `metricActivityScheduleTimeP90InMillis` ```typescript public metricActivityScheduleTimeP90InMillis(): MathExpression | Metric ``` ##### `metricActivityScheduleTimeP99InMillis` ```typescript public metricActivityScheduleTimeP99InMillis(): MathExpression | Metric ``` ##### `metricActivityTimeP50InMillis` ```typescript public metricActivityTimeP50InMillis(): MathExpression | Metric ``` ##### `metricActivityTimeP90InMillis` ```typescript public metricActivityTimeP90InMillis(): MathExpression | Metric ``` ##### `metricActivityTimeP99InMillis` ```typescript public metricActivityTimeP99InMillis(): MathExpression | Metric ``` ### StepFunctionActivityMonitoring #### Initializers ```typescript import { StepFunctionActivityMonitoring } from 'cdk-monitoring-constructs' new StepFunctionActivityMonitoring(scope: MonitoringScope, props: StepFunctionActivityMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | StepFunctionActivityMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* StepFunctionActivityMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | durationAlarmFactory | LatencyAlarmFactory | *No description.* | | durationAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | failedActivitiesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | failedActivitiesRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | heartbeatTimedOutActivitiesMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p50DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p90DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p99DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | scheduledActivitiesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | startedActivitiesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | succeededActivitiesMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | timedOutActivitiesMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | --- ##### `durationAlarmFactory`^Required ```typescript public readonly durationAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `durationAnnotations`^Required ```typescript public readonly durationAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `failedActivitiesMetric`^Required ```typescript public readonly failedActivitiesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `failedActivitiesRateMetric`^Required ```typescript public readonly failedActivitiesRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `heartbeatTimedOutActivitiesMetrics`^Required ```typescript public readonly heartbeatTimedOutActivitiesMetrics: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p50DurationMetric`^Required ```typescript public readonly p50DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p90DurationMetric`^Required ```typescript public readonly p90DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p99DurationMetric`^Required ```typescript public readonly p99DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `scheduledActivitiesMetric`^Required ```typescript public readonly scheduledActivitiesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `startedActivitiesMetric`^Required ```typescript public readonly startedActivitiesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `succeededActivitiesMetric`^Required ```typescript public readonly succeededActivitiesMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `timedOutActivitiesMetrics`^Required ```typescript public readonly timedOutActivitiesMetrics: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ### StepFunctionLambdaIntegrationMetricFactory #### Initializers ```typescript import { StepFunctionLambdaIntegrationMetricFactory } from 'cdk-monitoring-constructs' new StepFunctionLambdaIntegrationMetricFactory(metricFactory: MetricFactory, props: StepFunctionLambdaIntegrationMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | StepFunctionLambdaIntegrationMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* StepFunctionLambdaIntegrationMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricFunctionRunTimeP50InMillis | *No description.* | | metricFunctionRunTimeP90InMillis | *No description.* | | metricFunctionRunTimeP99InMillis | *No description.* | | metricFunctionScheduleTimeP50InMillis | *No description.* | | metricFunctionScheduleTimeP90InMillis | *No description.* | | metricFunctionScheduleTimeP99InMillis | *No description.* | | metricFunctionsFailed | *No description.* | | metricFunctionsFailedRate | *No description.* | | metricFunctionsScheduled | *No description.* | | metricFunctionsStarted | *No description.* | | metricFunctionsSucceeded | *No description.* | | metricFunctionsTimedOut | *No description.* | | metricFunctionTimeP50InMillis | *No description.* | | metricFunctionTimeP90InMillis | *No description.* | | metricFunctionTimeP99InMillis | *No description.* | --- ##### `metricFunctionRunTimeP50InMillis` ```typescript public metricFunctionRunTimeP50InMillis(): MathExpression | Metric ``` ##### `metricFunctionRunTimeP90InMillis` ```typescript public metricFunctionRunTimeP90InMillis(): MathExpression | Metric ``` ##### `metricFunctionRunTimeP99InMillis` ```typescript public metricFunctionRunTimeP99InMillis(): MathExpression | Metric ``` ##### `metricFunctionScheduleTimeP50InMillis` ```typescript public metricFunctionScheduleTimeP50InMillis(): MathExpression | Metric ``` ##### `metricFunctionScheduleTimeP90InMillis` ```typescript public metricFunctionScheduleTimeP90InMillis(): MathExpression | Metric ``` ##### `metricFunctionScheduleTimeP99InMillis` ```typescript public metricFunctionScheduleTimeP99InMillis(): MathExpression | Metric ``` ##### `metricFunctionsFailed` ```typescript public metricFunctionsFailed(): MathExpression | Metric ``` ##### `metricFunctionsFailedRate` ```typescript public metricFunctionsFailedRate(): MathExpression | Metric ``` ##### `metricFunctionsScheduled` ```typescript public metricFunctionsScheduled(): MathExpression | Metric ``` ##### `metricFunctionsStarted` ```typescript public metricFunctionsStarted(): MathExpression | Metric ``` ##### `metricFunctionsSucceeded` ```typescript public metricFunctionsSucceeded(): MathExpression | Metric ``` ##### `metricFunctionsTimedOut` ```typescript public metricFunctionsTimedOut(): MathExpression | Metric ``` ##### `metricFunctionTimeP50InMillis` ```typescript public metricFunctionTimeP50InMillis(): MathExpression | Metric ``` ##### `metricFunctionTimeP90InMillis` ```typescript public metricFunctionTimeP90InMillis(): MathExpression | Metric ``` ##### `metricFunctionTimeP99InMillis` ```typescript public metricFunctionTimeP99InMillis(): MathExpression | Metric ``` ### StepFunctionLambdaIntegrationMonitoring #### Initializers ```typescript import { StepFunctionLambdaIntegrationMonitoring } from 'cdk-monitoring-constructs' new StepFunctionLambdaIntegrationMonitoring(scope: MonitoringScope, props: StepFunctionLambdaIntegrationMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | StepFunctionLambdaIntegrationMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* StepFunctionLambdaIntegrationMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | durationAlarmFactory | LatencyAlarmFactory | *No description.* | | durationAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | failedFunctionRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | failedFunctionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p50DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p90DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p99DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | scheduledFunctionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | startedFunctionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | succeededFunctionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | timedOutFunctionsMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | functionUrl | string | *No description.* | --- ##### `durationAlarmFactory`^Required ```typescript public readonly durationAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `durationAnnotations`^Required ```typescript public readonly durationAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `failedFunctionRateMetric`^Required ```typescript public readonly failedFunctionRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `failedFunctionsMetric`^Required ```typescript public readonly failedFunctionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p50DurationMetric`^Required ```typescript public readonly p50DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p90DurationMetric`^Required ```typescript public readonly p90DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p99DurationMetric`^Required ```typescript public readonly p99DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `scheduledFunctionsMetric`^Required ```typescript public readonly scheduledFunctionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `startedFunctionsMetric`^Required ```typescript public readonly startedFunctionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `succeededFunctionsMetric`^Required ```typescript public readonly succeededFunctionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `timedOutFunctionsMetrics`^Required ```typescript public readonly timedOutFunctionsMetrics: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `functionUrl`^Optional ```typescript public readonly functionUrl: string; ``` - *Type:* string --- ### StepFunctionMetricFactory #### Initializers ```typescript import { StepFunctionMetricFactory } from 'cdk-monitoring-constructs' new StepFunctionMetricFactory(metricFactory: MetricFactory, props: StepFunctionMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | StepFunctionMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* StepFunctionMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricExecutionsAborted | *No description.* | | metricExecutionsFailed | *No description.* | | metricExecutionsFailedRate | *No description.* | | metricExecutionsStarted | *No description.* | | metricExecutionsSucceeded | *No description.* | | metricExecutionsTimedOut | *No description.* | | metricExecutionThrottled | *No description.* | | metricExecutionTimeP50InMillis | *No description.* | | metricExecutionTimeP90InMillis | *No description.* | | metricExecutionTimeP99InMillis | *No description.* | --- ##### `metricExecutionsAborted` ```typescript public metricExecutionsAborted(): MathExpression | Metric ``` ##### `metricExecutionsFailed` ```typescript public metricExecutionsFailed(): MathExpression | Metric ``` ##### `metricExecutionsFailedRate` ```typescript public metricExecutionsFailedRate(): MathExpression | Metric ``` ##### `metricExecutionsStarted` ```typescript public metricExecutionsStarted(): MathExpression | Metric ``` ##### `metricExecutionsSucceeded` ```typescript public metricExecutionsSucceeded(): MathExpression | Metric ``` ##### `metricExecutionsTimedOut` ```typescript public metricExecutionsTimedOut(): MathExpression | Metric ``` ##### `metricExecutionThrottled` ```typescript public metricExecutionThrottled(): MathExpression | Metric ``` ##### `metricExecutionTimeP50InMillis` ```typescript public metricExecutionTimeP50InMillis(): MathExpression | Metric ``` ##### `metricExecutionTimeP90InMillis` ```typescript public metricExecutionTimeP90InMillis(): MathExpression | Metric ``` ##### `metricExecutionTimeP99InMillis` ```typescript public metricExecutionTimeP99InMillis(): MathExpression | Metric ``` ### StepFunctionMonitoring #### Initializers ```typescript import { StepFunctionMonitoring } from 'cdk-monitoring-constructs' new StepFunctionMonitoring(scope: MonitoringScope, props: StepFunctionMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | StepFunctionMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* StepFunctionMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | abortedExecutionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | durationAlarmFactory | LatencyAlarmFactory | *No description.* | | durationAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | failedExecutionRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | failedExecutionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p50DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p90DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p99DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | startedExecutionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | succeededExecutionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | taskHealthAlarmFactory | TaskHealthAlarmFactory | *No description.* | | throttledExecutionsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | timedOutExecutionsMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | | stateMachineUrl | string | *No description.* | --- ##### `abortedExecutionsMetric`^Required ```typescript public readonly abortedExecutionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `durationAlarmFactory`^Required ```typescript public readonly durationAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `durationAnnotations`^Required ```typescript public readonly durationAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `failedExecutionRateMetric`^Required ```typescript public readonly failedExecutionRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `failedExecutionsMetric`^Required ```typescript public readonly failedExecutionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p50DurationMetric`^Required ```typescript public readonly p50DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p90DurationMetric`^Required ```typescript public readonly p90DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p99DurationMetric`^Required ```typescript public readonly p99DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `startedExecutionsMetric`^Required ```typescript public readonly startedExecutionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `succeededExecutionsMetric`^Required ```typescript public readonly succeededExecutionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `taskHealthAlarmFactory`^Required ```typescript public readonly taskHealthAlarmFactory: TaskHealthAlarmFactory; ``` - *Type:* TaskHealthAlarmFactory --- ##### `throttledExecutionsMetric`^Required ```typescript public readonly throttledExecutionsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `timedOutExecutionsMetrics`^Required ```typescript public readonly timedOutExecutionsMetrics: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ##### `stateMachineUrl`^Optional ```typescript public readonly stateMachineUrl: string; ``` - *Type:* string --- ### StepFunctionServiceIntegrationMetricFactory #### Initializers ```typescript import { StepFunctionServiceIntegrationMetricFactory } from 'cdk-monitoring-constructs' new StepFunctionServiceIntegrationMetricFactory(metricFactory: MetricFactory, props: StepFunctionServiceIntegrationMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | StepFunctionServiceIntegrationMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* StepFunctionServiceIntegrationMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricServiceIntegrationRunTimeP50InMillis | *No description.* | | metricServiceIntegrationRunTimeP90InMillis | *No description.* | | metricServiceIntegrationRunTimeP99InMillis | *No description.* | | metricServiceIntegrationScheduleTimeP50InMillis | *No description.* | | metricServiceIntegrationScheduleTimeP90InMillis | *No description.* | | metricServiceIntegrationScheduleTimeP99InMillis | *No description.* | | metricServiceIntegrationsFailed | *No description.* | | metricServiceIntegrationsFailedRate | *No description.* | | metricServiceIntegrationsScheduled | *No description.* | | metricServiceIntegrationsStarted | *No description.* | | metricServiceIntegrationsSucceeded | *No description.* | | metricServiceIntegrationsTimedOut | *No description.* | | metricServiceIntegrationTimeP50InMillis | *No description.* | | metricServiceIntegrationTimeP90InMillis | *No description.* | | metricServiceIntegrationTimeP99InMillis | *No description.* | --- ##### `metricServiceIntegrationRunTimeP50InMillis` ```typescript public metricServiceIntegrationRunTimeP50InMillis(): MathExpression | Metric ``` ##### `metricServiceIntegrationRunTimeP90InMillis` ```typescript public metricServiceIntegrationRunTimeP90InMillis(): MathExpression | Metric ``` ##### `metricServiceIntegrationRunTimeP99InMillis` ```typescript public metricServiceIntegrationRunTimeP99InMillis(): MathExpression | Metric ``` ##### `metricServiceIntegrationScheduleTimeP50InMillis` ```typescript public metricServiceIntegrationScheduleTimeP50InMillis(): MathExpression | Metric ``` ##### `metricServiceIntegrationScheduleTimeP90InMillis` ```typescript public metricServiceIntegrationScheduleTimeP90InMillis(): MathExpression | Metric ``` ##### `metricServiceIntegrationScheduleTimeP99InMillis` ```typescript public metricServiceIntegrationScheduleTimeP99InMillis(): MathExpression | Metric ``` ##### `metricServiceIntegrationsFailed` ```typescript public metricServiceIntegrationsFailed(): MathExpression | Metric ``` ##### `metricServiceIntegrationsFailedRate` ```typescript public metricServiceIntegrationsFailedRate(): MathExpression | Metric ``` ##### `metricServiceIntegrationsScheduled` ```typescript public metricServiceIntegrationsScheduled(): MathExpression | Metric ``` ##### `metricServiceIntegrationsStarted` ```typescript public metricServiceIntegrationsStarted(): MathExpression | Metric ``` ##### `metricServiceIntegrationsSucceeded` ```typescript public metricServiceIntegrationsSucceeded(): MathExpression | Metric ``` ##### `metricServiceIntegrationsTimedOut` ```typescript public metricServiceIntegrationsTimedOut(): MathExpression | Metric ``` ##### `metricServiceIntegrationTimeP50InMillis` ```typescript public metricServiceIntegrationTimeP50InMillis(): MathExpression | Metric ``` ##### `metricServiceIntegrationTimeP90InMillis` ```typescript public metricServiceIntegrationTimeP90InMillis(): MathExpression | Metric ``` ##### `metricServiceIntegrationTimeP99InMillis` ```typescript public metricServiceIntegrationTimeP99InMillis(): MathExpression | Metric ``` ### StepFunctionServiceIntegrationMonitoring #### Initializers ```typescript import { StepFunctionServiceIntegrationMonitoring } from 'cdk-monitoring-constructs' new StepFunctionServiceIntegrationMonitoring(scope: MonitoringScope, props: StepFunctionServiceIntegrationMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | StepFunctionServiceIntegrationMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* StepFunctionServiceIntegrationMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | durationAlarmFactory | LatencyAlarmFactory | *No description.* | | durationAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | failedServiceIntegrationRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | failedServiceIntegrationsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p50DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p90DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | p99DurationMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | scheduledServiceIntegrationsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | startedServiceIntegrationsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | succeededServiceIntegrationsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | timedOutServiceIntegrationsMetrics | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | title | string | *No description.* | --- ##### `durationAlarmFactory`^Required ```typescript public readonly durationAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `durationAnnotations`^Required ```typescript public readonly durationAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `failedServiceIntegrationRateMetric`^Required ```typescript public readonly failedServiceIntegrationRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `failedServiceIntegrationsMetric`^Required ```typescript public readonly failedServiceIntegrationsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p50DurationMetric`^Required ```typescript public readonly p50DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p90DurationMetric`^Required ```typescript public readonly p90DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `p99DurationMetric`^Required ```typescript public readonly p99DurationMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `scheduledServiceIntegrationsMetric`^Required ```typescript public readonly scheduledServiceIntegrationsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `startedServiceIntegrationsMetric`^Required ```typescript public readonly startedServiceIntegrationsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `succeededServiceIntegrationsMetric`^Required ```typescript public readonly succeededServiceIntegrationsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `timedOutServiceIntegrationsMetrics`^Required ```typescript public readonly timedOutServiceIntegrationsMetrics: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `title`^Required ```typescript public readonly title: string; ``` - *Type:* string --- ### SyntheticsCanaryMetricFactory #### Initializers ```typescript import { SyntheticsCanaryMetricFactory } from 'cdk-monitoring-constructs' new SyntheticsCanaryMetricFactory(metricFactory: MetricFactory, props: SyntheticsCanaryMetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | SyntheticsCanaryMetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* SyntheticsCanaryMetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metric4xxErrorCount | *No description.* | | metric4xxErrorRate | *No description.* | | metric5xxFaultCount | *No description.* | | metric5xxFaultRate | *No description.* | | metricLatencyAverageInMillis | *No description.* | | metricSuccessInPercent | *No description.* | --- ##### `metric4xxErrorCount` ```typescript public metric4xxErrorCount(): MathExpression | Metric ``` ##### `metric4xxErrorRate` ```typescript public metric4xxErrorRate(): MathExpression | Metric ``` ##### `metric5xxFaultCount` ```typescript public metric5xxFaultCount(): MathExpression | Metric ``` ##### `metric5xxFaultRate` ```typescript public metric5xxFaultRate(): MathExpression | Metric ``` ##### `metricLatencyAverageInMillis` ```typescript public metricLatencyAverageInMillis(): MathExpression | Metric ``` ##### `metricSuccessInPercent` ```typescript public metricSuccessInPercent(): MathExpression | Metric ``` ### SyntheticsCanaryMonitoring Monitoring for CloudWatch Synthetics Canaries. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html) #### Initializers ```typescript import { SyntheticsCanaryMonitoring } from 'cdk-monitoring-constructs' new SyntheticsCanaryMonitoring(scope: MonitoringScope, props: SyntheticsCanaryMonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | SyntheticsCanaryMonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* SyntheticsCanaryMonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createErrorCountWidget | *No description.* | | createErrorRateWidget | *No description.* | | createLatencyWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createErrorCountWidget` ```typescript public createErrorCountWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createErrorRateWidget` ```typescript public createErrorRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createLatencyWidget` ```typescript public createLatencyWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | averageLatencyMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | faultCountMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | faultRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | humanReadableName | string | *No description.* | | latencyAlarmFactory | LatencyAlarmFactory | *No description.* | | latencyAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | --- ##### `averageLatencyMetric`^Required ```typescript public readonly averageLatencyMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorCountMetric`^Required ```typescript public readonly errorCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateMetric`^Required ```typescript public readonly errorRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `faultCountMetric`^Required ```typescript public readonly faultCountMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `faultRateMetric`^Required ```typescript public readonly faultRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `humanReadableName`^Required ```typescript public readonly humanReadableName: string; ``` - *Type:* string --- ##### `latencyAlarmFactory`^Required ```typescript public readonly latencyAlarmFactory: LatencyAlarmFactory; ``` - *Type:* LatencyAlarmFactory --- ##### `latencyAnnotations`^Required ```typescript public readonly latencyAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ### TaskHealthAlarmFactory #### Initializers ```typescript import { TaskHealthAlarmFactory } from 'cdk-monitoring-constructs' new TaskHealthAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addAvailabilityAlarm | *No description.* | | addHealthyTaskCountAlarm | *No description.* | | addHealthyTaskPercentAlarm | *No description.* | | addMinRunningTaskCountAlarm | *No description.* | | addRunningTaskCountAlarm | *No description.* | | addRunningTaskRateAlarm | *No description.* | | addUnhealthyTaskCountAlarm | *No description.* | --- ##### `addAvailabilityAlarm` ```typescript public addAvailabilityAlarm(metric: MathExpression | Metric, props: AvailabilityThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* AvailabilityThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addHealthyTaskCountAlarm` ```typescript public addHealthyTaskCountAlarm(metric: MathExpression | Metric, props: HealthyTaskCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* HealthyTaskCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addHealthyTaskPercentAlarm` ```typescript public addHealthyTaskPercentAlarm(metric: MathExpression | Metric, props: HealthyTaskPercentThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* HealthyTaskPercentThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinRunningTaskCountAlarm` ```typescript public addMinRunningTaskCountAlarm(metric: MathExpression | Metric, props: MinRunningTaskCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinRunningTaskCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addRunningTaskCountAlarm` ```typescript public addRunningTaskCountAlarm(metric: MathExpression | Metric, props: RunningTaskCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* RunningTaskCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addRunningTaskRateAlarm` ```typescript public addRunningTaskRateAlarm(metric: MathExpression | Metric, props: RunningTaskRateThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* RunningTaskRateThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addUnhealthyTaskCountAlarm` ```typescript public addUnhealthyTaskCountAlarm(metric: MathExpression | Metric, props: UnhealthyTaskCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UnhealthyTaskCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### ThroughputAlarmFactory #### Initializers ```typescript import { ThroughputAlarmFactory } from 'cdk-monitoring-constructs' new ThroughputAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addMinProcessedBytesAlarm | *No description.* | --- ##### `addMinProcessedBytesAlarm` ```typescript public addMinProcessedBytesAlarm(metric: MathExpression | Metric, props: MinProcessedBytesThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinProcessedBytesThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### TopicAlarmFactory #### Initializers ```typescript import { TopicAlarmFactory } from 'cdk-monitoring-constructs' new TopicAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addMaxMessagesPublishedAlarm | *No description.* | | addMessageNotificationsFailedAlarm | *No description.* | | addMinMessagesPublishedAlarm | *No description.* | --- ##### `addMaxMessagesPublishedAlarm` ```typescript public addMaxMessagesPublishedAlarm(metric: MathExpression | Metric, props: HighMessagesPublishedThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* HighMessagesPublishedThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMessageNotificationsFailedAlarm` ```typescript public addMessageNotificationsFailedAlarm(metric: MathExpression | Metric, props: NotificationsFailedThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* NotificationsFailedThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinMessagesPublishedAlarm` ```typescript public addMinMessagesPublishedAlarm(metric: MathExpression | Metric, props: LowMessagesPublishedThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* LowMessagesPublishedThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### TpsAlarmFactory #### Initializers ```typescript import { TpsAlarmFactory } from 'cdk-monitoring-constructs' new TpsAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addMaxTpsAlarm | *No description.* | | addMinTpsAlarm | *No description.* | --- ##### `addMaxTpsAlarm` ```typescript public addMaxTpsAlarm(metric: MathExpression | Metric, props: HighTpsThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* HighTpsThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinTpsAlarm` ```typescript public addMinTpsAlarm(metric: MathExpression | Metric, props: LowTpsThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* LowTpsThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### UsageAlarmFactory #### Initializers ```typescript import { UsageAlarmFactory } from 'cdk-monitoring-constructs' new UsageAlarmFactory(alarmFactory: AlarmFactory) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | --- ##### `alarmFactory`^Required - *Type:* AlarmFactory --- #### Methods | **Name** | **Description** | | --- | --- | | addMaxCountAlarm | *No description.* | | addMaxCpuUsagePercentAlarm | *No description.* | | addMaxDiskUsagePercentAlarm | *No description.* | | addMaxFileDescriptorPercentAlarm | *No description.* | | addMaxHeapMemoryAfterGCUsagePercentAlarm | *No description.* | | addMaxMasterCpuUsagePercentAlarm | *No description.* | | addMaxMasterMemoryUsagePercentAlarm | *No description.* | | addMaxMemoryUsagePercentAlarm | *No description.* | | addMaxReadIOPSAlarm | *No description.* | | addMaxThreadCountUsageAlarm | *No description.* | | addMaxUsageCountAlarm | *No description.* | | addMaxWriteIOPSAlarm | *No description.* | | addMemoryUsagePercentAlarm | *No description.* | | addMinCountAlarm | *No description.* | | addMinUsageCountAlarm | *No description.* | --- ##### `addMaxCountAlarm` ```typescript public addMaxCountAlarm(metric: MathExpression | Metric, props: MaxUsageCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxUsageCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxCpuUsagePercentAlarm` ```typescript public addMaxCpuUsagePercentAlarm(percentMetric: MathExpression | Metric, props: UsageThreshold, disambiguator?: string, usageType?: UsageType, additionalAlarmNameSuffix?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ###### `usageType`^Optional - *Type:* UsageType --- ###### `additionalAlarmNameSuffix`^Optional - *Type:* string --- ##### `addMaxDiskUsagePercentAlarm` ```typescript public addMaxDiskUsagePercentAlarm(percentMetric: MathExpression | Metric, props: UsageThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxFileDescriptorPercentAlarm` ```typescript public addMaxFileDescriptorPercentAlarm(percentMetric: MathExpression | Metric, props: UsageThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxHeapMemoryAfterGCUsagePercentAlarm` ```typescript public addMaxHeapMemoryAfterGCUsagePercentAlarm(percentMetric: MathExpression | Metric, props: UsageThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxMasterCpuUsagePercentAlarm` ```typescript public addMaxMasterCpuUsagePercentAlarm(percentMetric: MathExpression | Metric, props: UsageThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxMasterMemoryUsagePercentAlarm` ```typescript public addMaxMasterMemoryUsagePercentAlarm(percentMetric: MathExpression | Metric, props: UsageThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxMemoryUsagePercentAlarm` ```typescript public addMaxMemoryUsagePercentAlarm(percentMetric: MathExpression | Metric, props: UsageThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxReadIOPSAlarm` ```typescript public addMaxReadIOPSAlarm(metric: MathExpression | Metric, props: MaxUsageCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxUsageCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxThreadCountUsageAlarm` ```typescript public addMaxThreadCountUsageAlarm(percentMetric: MathExpression | Metric, props: UsageCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### ~~`addMaxUsageCountAlarm`~~ ```typescript public addMaxUsageCountAlarm(metric: MathExpression | Metric, props: UsageCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMaxWriteIOPSAlarm` ```typescript public addMaxWriteIOPSAlarm(metric: MathExpression | Metric, props: MaxUsageCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MaxUsageCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMemoryUsagePercentAlarm` ```typescript public addMemoryUsagePercentAlarm(percentMetric: MathExpression | Metric, props: UsageThreshold, usageType: UsageType, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* UsageThreshold --- ###### `usageType`^Required - *Type:* UsageType --- ###### `disambiguator`^Optional - *Type:* string --- ##### `addMinCountAlarm` ```typescript public addMinCountAlarm(percentMetric: MathExpression | Metric, props: MinUsageCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinUsageCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ##### ~~`addMinUsageCountAlarm`~~ ```typescript public addMinUsageCountAlarm(percentMetric: MathExpression | Metric, props: MinUsageCountThreshold, disambiguator?: string): AlarmWithAnnotation ``` ###### `percentMetric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ###### `props`^Required - *Type:* MinUsageCountThreshold --- ###### `disambiguator`^Optional - *Type:* string --- ### WafV2MetricFactory https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html. #### Initializers ```typescript import { WafV2MetricFactory } from 'cdk-monitoring-constructs' new WafV2MetricFactory(metricFactory: MetricFactory, props: WafV2MetricFactoryProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | metricFactory | MetricFactory | *No description.* | | props | WafV2MetricFactoryProps | *No description.* | --- ##### `metricFactory`^Required - *Type:* MetricFactory --- ##### `props`^Required - *Type:* WafV2MetricFactoryProps --- #### Methods | **Name** | **Description** | | --- | --- | | metricAllowedRequests | *No description.* | | metricBlockedRequests | *No description.* | | metricBlockedRequestsRate | *No description.* | --- ##### `metricAllowedRequests` ```typescript public metricAllowedRequests(): MathExpression | Metric ``` ##### `metricBlockedRequests` ```typescript public metricBlockedRequests(): MathExpression | Metric ``` ##### `metricBlockedRequestsRate` ```typescript public metricBlockedRequestsRate(): MathExpression | Metric ``` ### WafV2Monitoring Monitoring for AWS Web Application Firewall. > [https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html](https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html) #### Initializers ```typescript import { WafV2Monitoring } from 'cdk-monitoring-constructs' new WafV2Monitoring(scope: MonitoringScope, props: WafV2MonitoringProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | MonitoringScope | *No description.* | | props | WafV2MonitoringProps | *No description.* | --- ##### `scope`^Required - *Type:* MonitoringScope --- ##### `props`^Required - *Type:* WafV2MonitoringProps --- #### Methods | **Name** | **Description** | | --- | --- | | addAlarm | Adds an alarm. | | alarmWidgets | Returns widgets for all alarms. | | createAlarmFactory | Creates a new alarm factory. | | createdAlarms | Returns all the alarms created. | | createMetricFactory | Creates a new metric factory. | | createWidgetFactory | Creates a new widget factory. | | summaryWidgets | Returns widgets to be placed on the summary dashboard. | | widgets | Returns widgets to be placed on the main dashboard. | | widgetsForDashboard | Returns widgets for the requested dashboard type. | | createAllowedRequestsWidget | *No description.* | | createBlockedRequestsRateWidget | *No description.* | | createBlockedRequestsWidget | *No description.* | | createTitleWidget | *No description.* | --- ##### `addAlarm` ```typescript public addAlarm(alarm: AlarmWithAnnotation): void ``` Adds an alarm. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to add. --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These can go to runbook or to service dashboard. ##### `createAlarmFactory` ```typescript public createAlarmFactory(alarmNamePrefix: string): AlarmFactory ``` Creates a new alarm factory. Alarms created will be named with the given prefix, unless a local name override is present. ###### `alarmNamePrefix`^Required - *Type:* string alarm name prefix. --- ##### `createdAlarms` ```typescript public createdAlarms(): AlarmWithAnnotation[] ``` Returns all the alarms created. ##### `createMetricFactory` ```typescript public createMetricFactory(): MetricFactory ``` Creates a new metric factory. ##### `createWidgetFactory` ```typescript public createWidgetFactory(): IWidgetFactory ``` Creates a new widget factory. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets to be placed on the summary dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns widgets to be placed on the main dashboard. ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string --- ##### `createAllowedRequestsWidget` ```typescript public createAllowedRequestsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createBlockedRequestsRateWidget` ```typescript public createBlockedRequestsRateWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createBlockedRequestsWidget` ```typescript public createBlockedRequestsWidget(width: number, height: number): GraphWidget ``` ###### `width`^Required - *Type:* number --- ###### `height`^Required - *Type:* number --- ##### `createTitleWidget` ```typescript public createTitleWidget(): MonitoringHeaderWidget ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmFactory | AlarmFactory | *No description.* | | allowedRequestsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | blockedRequestsMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | blockedRequestsRateMetric | aws-cdk-lib.aws_cloudwatch.MathExpression \| aws-cdk-lib.aws_cloudwatch.Metric | *No description.* | | errorAlarmFactory | ErrorAlarmFactory | *No description.* | | errorCountAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | errorRateAnnotations | aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] | *No description.* | | humanReadableName | string | *No description.* | --- ##### `alarmFactory`^Required ```typescript public readonly alarmFactory: AlarmFactory; ``` - *Type:* AlarmFactory --- ##### `allowedRequestsMetric`^Required ```typescript public readonly allowedRequestsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `blockedRequestsMetric`^Required ```typescript public readonly blockedRequestsMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `blockedRequestsRateMetric`^Required ```typescript public readonly blockedRequestsRateMetric: MathExpression | Metric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric --- ##### `errorAlarmFactory`^Required ```typescript public readonly errorAlarmFactory: ErrorAlarmFactory; ``` - *Type:* ErrorAlarmFactory --- ##### `errorCountAnnotations`^Required ```typescript public readonly errorCountAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `errorRateAnnotations`^Required ```typescript public readonly errorRateAnnotations: HorizontalAnnotation[]; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.HorizontalAnnotation[] --- ##### `humanReadableName`^Required ```typescript public readonly humanReadableName: string; ``` - *Type:* string --- ## Protocols ### IAlarmActionStrategy - *Implemented By:* LambdaAlarmActionStrategy, MultipleAlarmActionStrategy, NoopAlarmActionStrategy, OpsItemAlarmActionStrategy, SnsAlarmActionStrategy, IAlarmActionStrategy An object that appends actions to alarms. #### Methods | **Name** | **Description** | | --- | --- | | addAlarmActions | *No description.* | --- ##### `addAlarmActions` ```typescript public addAlarmActions(props: AlarmActionStrategyProps): void ``` ###### `props`^Required - *Type:* AlarmActionStrategyProps --- ### IAlarmAnnotationStrategy - *Implemented By:* DefaultAlarmAnnotationStrategy, FillingAlarmAnnotationStrategy, IAlarmAnnotationStrategy Helper class for creating annotations for alarms. #### Methods | **Name** | **Description** | | --- | --- | | createAnnotation | Creates annotation based on the metric and alarm properties. | --- ##### `createAnnotation` ```typescript public createAnnotation(props: AlarmAnnotationStrategyProps): HorizontalAnnotation ``` Creates annotation based on the metric and alarm properties. ###### `props`^Required - *Type:* AlarmAnnotationStrategyProps properties necessary to create annotation. --- ### IAlarmConsumer - *Implemented By:* IAlarmConsumer #### Methods | **Name** | **Description** | | --- | --- | | consume | *No description.* | --- ##### `consume` ```typescript public consume(alarms: AlarmWithAnnotation[]): void ``` ###### `alarms`^Required - *Type:* AlarmWithAnnotation[] --- ### IAlarmDedupeStringProcessor - *Implemented By:* DoNotModifyDedupeString, ExtendDedupeString, IAlarmDedupeStringProcessor Strategy used to finalize dedupe string. #### Methods | **Name** | **Description** | | --- | --- | | processDedupeString | Process the dedupe string which was auto-generated. | | processDedupeStringOverride | Process the dedupe string which was specified by the user as an override. | --- ##### `processDedupeString` ```typescript public processDedupeString(dedupeString: string): string ``` Process the dedupe string which was auto-generated. ###### `dedupeString`^Required - *Type:* string --- ##### `processDedupeStringOverride` ```typescript public processDedupeStringOverride(dedupeString: string): string ``` Process the dedupe string which was specified by the user as an override. ###### `dedupeString`^Required - *Type:* string --- ### IAlarmNamingStrategy - *Implemented By:* AlarmNamingStrategy, IAlarmNamingStrategy Strategy used to name alarms, their widgets, and their dedupe strings. #### Methods | **Name** | **Description** | | --- | --- | | getDedupeString | How to generate the deduplication string for an alarm. | | getName | How to generate the name of an alarm. | | getWidgetLabel | How to generate the label for the alarm displayed on a widget. | --- ##### `getDedupeString` ```typescript public getDedupeString(props: AlarmNamingInput): string ``` How to generate the deduplication string for an alarm. ###### `props`^Required - *Type:* AlarmNamingInput --- ##### `getName` ```typescript public getName(props: AlarmNamingInput): string ``` How to generate the name of an alarm. ###### `props`^Required - *Type:* AlarmNamingInput AlarmNamingInput. --- ##### `getWidgetLabel` ```typescript public getWidgetLabel(props: AlarmNamingInput): string ``` How to generate the label for the alarm displayed on a widget. ###### `props`^Required - *Type:* AlarmNamingInput AlarmNamingInput. --- ### IDashboardFactory - *Implemented By:* DefaultDashboardFactory, IDashboardFactory #### Methods | **Name** | **Description** | | --- | --- | | addSegment | *No description.* | | createdAlarmDashboard | *No description.* | | createdDashboard | *No description.* | | createdSummaryDashboard | *No description.* | --- ##### `addSegment` ```typescript public addSegment(props: IDashboardFactoryProps): void ``` ###### `props`^Required - *Type:* IDashboardFactoryProps --- ##### `createdAlarmDashboard` ```typescript public createdAlarmDashboard(): Dashboard ``` ##### `createdDashboard` ```typescript public createdDashboard(): Dashboard ``` ##### `createdSummaryDashboard` ```typescript public createdSummaryDashboard(): Dashboard ``` ### IDashboardFactoryProps - *Implemented By:* IDashboardFactoryProps #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | segment | IDashboardSegment | Segment to be placed on the dashboard. | | overrideProps | MonitoringDashboardsOverrideProps | Dashboard placement override props. | --- ##### `segment`^Required ```typescript public readonly segment: IDashboardSegment; ``` - *Type:* IDashboardSegment Segment to be placed on the dashboard. --- ##### `overrideProps`^Optional ```typescript public readonly overrideProps: MonitoringDashboardsOverrideProps; ``` - *Type:* MonitoringDashboardsOverrideProps - *Default:* all default Dashboard placement override props. --- ### IDashboardSegment - *Implemented By:* ApiGatewayMonitoring, ApiGatewayV2HttpApiMonitoring, AppSyncMonitoring, AuroraClusterMonitoring, AutoScalingGroupMonitoring, BillingMonitoring, CertificateManagerMonitoring, CloudFrontDistributionMonitoring, CodeBuildProjectMonitoring, CustomMonitoring, DocumentDbMonitoring, DynamoTableGlobalSecondaryIndexMonitoring, DynamoTableMonitoring, EC2Monitoring, Ec2ServiceMonitoring, ElastiCacheClusterMonitoring, ElastiCacheServerlessMonitoring, FargateServiceMonitoring, FluentBitMonitoring, GlueJobMonitoring, KinesisDataAnalyticsMonitoring, KinesisDataStreamConsumerMonitoring, KinesisDataStreamMonitoring, KinesisFirehoseMonitoring, LambdaFunctionMonitoring, LogMonitoring, Monitoring, NetworkLoadBalancerMonitoring, OpenSearchClusterMonitoring, OpenSearchIngestionPipelineMonitoring, OpenSearchServerlessIndexMonitoring, OpenSearchServerlessMonitoring, RdsClusterMonitoring, RdsInstanceMonitoring, RedshiftClusterMonitoring, S3BucketMonitoring, SecretsManagerMonitoring, SecretsManagerSecretMonitoring, SingleWidgetDashboardSegment, SnsTopicMonitoring, SqsQueueMonitoring, SqsQueueMonitoringWithDlq, StepFunctionActivityMonitoring, StepFunctionLambdaIntegrationMonitoring, StepFunctionMonitoring, StepFunctionServiceIntegrationMonitoring, SyntheticsCanaryMonitoring, WafV2Monitoring, IDashboardSegment #### Methods | **Name** | **Description** | | --- | --- | | alarmWidgets | Returns widgets for all alarms. | | summaryWidgets | Returns widgets for the summary. | | widgets | Returns all widgets. | --- ##### `alarmWidgets` ```typescript public alarmWidgets(): IWidget[] ``` Returns widgets for all alarms. These should go to the runbook or service dashboard. ##### `summaryWidgets` ```typescript public summaryWidgets(): IWidget[] ``` Returns widgets for the summary. These should go to the team OPS dashboard. ##### `widgets` ```typescript public widgets(): IWidget[] ``` Returns all widgets. These should go to the detailed service dashboard. ### IDynamicDashboardFactory - *Implemented By:* DefaultDashboardFactory, DynamicDashboardFactory, IDynamicDashboardFactory This dashboard factory interface provides for dynamic dashboard generation through IDynamicDashboard segments which will return different content depending on the dashboard type. #### Methods | **Name** | **Description** | | --- | --- | | addDynamicSegment | Adds a dynamic dashboard segment. | | getDashboard | Gets the dashboard for the requested dashboard type. | --- ##### `addDynamicSegment` ```typescript public addDynamicSegment(segment: IDynamicDashboardSegment): void ``` Adds a dynamic dashboard segment. ###### `segment`^Required - *Type:* IDynamicDashboardSegment IDynamicDashboardSegment. --- ##### `getDashboard` ```typescript public getDashboard(type: string): Dashboard ``` Gets the dashboard for the requested dashboard type. ###### `type`^Required - *Type:* string --- ### IDynamicDashboardSegment - *Implemented By:* ApiGatewayMonitoring, ApiGatewayV2HttpApiMonitoring, AppSyncMonitoring, AuroraClusterMonitoring, AutoScalingGroupMonitoring, BillingMonitoring, CertificateManagerMonitoring, CloudFrontDistributionMonitoring, CodeBuildProjectMonitoring, CustomMonitoring, DocumentDbMonitoring, DynamoTableGlobalSecondaryIndexMonitoring, DynamoTableMonitoring, EC2Monitoring, Ec2ServiceMonitoring, ElastiCacheClusterMonitoring, ElastiCacheServerlessMonitoring, FargateServiceMonitoring, FluentBitMonitoring, GlueJobMonitoring, KinesisDataAnalyticsMonitoring, KinesisDataStreamConsumerMonitoring, KinesisDataStreamMonitoring, KinesisFirehoseMonitoring, LambdaFunctionMonitoring, LogMonitoring, Monitoring, NetworkLoadBalancerMonitoring, OpenSearchClusterMonitoring, OpenSearchIngestionPipelineMonitoring, OpenSearchServerlessIndexMonitoring, OpenSearchServerlessMonitoring, RdsClusterMonitoring, RdsInstanceMonitoring, RedshiftClusterMonitoring, S3BucketMonitoring, SecretsManagerMonitoring, SecretsManagerSecretMonitoring, SingleWidgetDashboardSegment, SnsTopicMonitoring, SqsQueueMonitoring, SqsQueueMonitoringWithDlq, StaticSegmentDynamicAdapter, StepFunctionActivityMonitoring, StepFunctionLambdaIntegrationMonitoring, StepFunctionMonitoring, StepFunctionServiceIntegrationMonitoring, SyntheticsCanaryMonitoring, WafV2Monitoring, IDynamicDashboardSegment #### Methods | **Name** | **Description** | | --- | --- | | widgetsForDashboard | Returns widgets for the requested dashboard type. | --- ##### `widgetsForDashboard` ```typescript public widgetsForDashboard(name: string): IWidget[] ``` Returns widgets for the requested dashboard type. ###### `name`^Required - *Type:* string name of dashboard for which widgets are generated. --- ### IEC2MetricFactoryStrategy - *Implemented By:* IEC2MetricFactoryStrategy #### Methods | **Name** | **Description** | | --- | --- | | createMetrics | *No description.* | --- ##### `createMetrics` ```typescript public createMetrics(metricFactory: MetricFactory, metricName: string, statistic: MetricStatistic, region?: string, account?: string, label?: string): (MathExpression | Metric)[] ``` ###### `metricFactory`^Required - *Type:* MetricFactory --- ###### `metricName`^Required - *Type:* string --- ###### `statistic`^Required - *Type:* MetricStatistic --- ###### `region`^Optional - *Type:* string --- ###### `account`^Optional - *Type:* string --- ###### `label`^Optional - *Type:* string --- ### ILoadBalancerMetricFactory - *Implemented By:* ApplicationLoadBalancerMetricFactory, NetworkLoadBalancerMetricFactory, ILoadBalancerMetricFactory Common interface for load-balancer based service metric factories. #### Methods | **Name** | **Description** | | --- | --- | | metricActiveConnectionCount | *No description.* | | metricHealthyTaskCount | *No description.* | | metricHealthyTaskInPercent | *No description.* | | metricNewConnectionCount | *No description.* | | metricProcessedBytesMin | *No description.* | | metricUnhealthyRoutingCount | *No description.* | | metricUnhealthyTaskCount | *No description.* | --- ##### `metricActiveConnectionCount` ```typescript public metricActiveConnectionCount(): MathExpression | Metric ``` ##### `metricHealthyTaskCount` ```typescript public metricHealthyTaskCount(): MathExpression | Metric ``` ##### `metricHealthyTaskInPercent` ```typescript public metricHealthyTaskInPercent(): MathExpression | Metric ``` ##### `metricNewConnectionCount` ```typescript public metricNewConnectionCount(): MathExpression | Metric ``` ##### `metricProcessedBytesMin` ```typescript public metricProcessedBytesMin(): MathExpression | Metric ``` ##### `metricUnhealthyRoutingCount` ```typescript public metricUnhealthyRoutingCount(): MathExpression | Metric ``` ##### `metricUnhealthyTaskCount` ```typescript public metricUnhealthyTaskCount(): MathExpression | Metric ``` ### IMetricAdjuster - *Implemented By:* CompositeMetricAdjuster, DefaultMetricAdjuster, Route53HealthCheckMetricAdjuster, IMetricAdjuster Adjusts a metric before creating adding an alarm to it. #### Methods | **Name** | **Description** | | --- | --- | | adjustMetric | Adjusts a metric. | --- ##### `adjustMetric` ```typescript public adjustMetric(metric: MathExpression | Metric, alarmScope: Construct, props: AddAlarmProps): MathExpression | Metric ``` Adjusts a metric. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_cloudwatch.MathExpression | aws-cdk-lib.aws_cloudwatch.Metric The metric to adjust. --- ###### `alarmScope`^Required - *Type:* constructs.Construct The alarm scope. --- ###### `props`^Required - *Type:* AddAlarmProps The props specified for adding the alarm. --- ### IPublisherConsumer - *Implemented By:* IPublisherConsumer #### Methods | **Name** | **Description** | | --- | --- | | consume | *No description.* | --- ##### `consume` ```typescript public consume(lambdaFunction: IFunction): void ``` ###### `lambdaFunction`^Required - *Type:* aws-cdk-lib.aws_lambda.IFunction --- ### IWidgetFactory - *Implemented By:* DefaultWidgetFactory, IWidgetFactory Strategy for creating widgets. #### Methods | **Name** | **Description** | | --- | --- | | createAlarmDetailWidget | Create widget representing an alarm detail. | --- ##### `createAlarmDetailWidget` ```typescript public createAlarmDetailWidget(alarm: AlarmWithAnnotation): IWidget ``` Create widget representing an alarm detail. ###### `alarm`^Required - *Type:* AlarmWithAnnotation alarm to represent. --- ## Enums ### AxisPosition #### Members | **Name** | **Description** | | --- | --- | | LEFT | *No description.* | | RIGHT | *No description.* | --- ##### `LEFT` --- ##### `RIGHT` --- ### CapacityType #### Members | **Name** | **Description** | | --- | --- | | READ | *No description.* | | WRITE | *No description.* | --- ##### `READ` --- ##### `WRITE` --- ### CompositeAlarmOperator #### Members | **Name** | **Description** | | --- | --- | | AND | trigger only if all the alarms are triggered. | | OR | trigger if any of the alarms is triggered. | --- ##### `AND` trigger only if all the alarms are triggered. --- ##### `OR` trigger if any of the alarms is triggered. --- ### DashboardRenderingPreference Preferred way of rendering dashboard widgets. #### Members | **Name** | **Description** | | --- | --- | | INTERACTIVE_ONLY | Create standard set of dashboards with interactive widgets only. | | BITMAP_ONLY | Create standard set of dashboards with bitmap widgets only. | | INTERACTIVE_AND_BITMAP | Create a two sets of dashboards: standard set (interactive) and a copy (bitmap). | --- ##### `INTERACTIVE_ONLY` Create standard set of dashboards with interactive widgets only. --- ##### `BITMAP_ONLY` Create standard set of dashboards with bitmap widgets only. --- ##### `INTERACTIVE_AND_BITMAP` Create a two sets of dashboards: standard set (interactive) and a copy (bitmap). --- ### DefaultDashboards #### Members | **Name** | **Description** | | --- | --- | | SUMMARY | *No description.* | | DETAIL | *No description.* | | ALARMS | *No description.* | --- ##### `SUMMARY` --- ##### `DETAIL` --- ##### `ALARMS` --- ### ElastiCacheClusterType #### Members | **Name** | **Description** | | --- | --- | | MEMCACHED | *No description.* | | REDIS | *No description.* | --- ##### `MEMCACHED` --- ##### `REDIS` --- ### ElasticsearchClusterStatus #### Members | **Name** | **Description** | | --- | --- | | RED | *No description.* | | YELLOW | *No description.* | --- ##### `RED` --- ##### `YELLOW` --- ### ErrorType #### Members | **Name** | **Description** | | --- | --- | | FAULT | *No description.* | | ERROR | *No description.* | | SYSTEM_ERROR | *No description.* | | USER_ERROR | *No description.* | | FAILURE | *No description.* | | ABORTED | *No description.* | | THROTTLED | *No description.* | | TIMED_OUT | *No description.* | | READ_ERROR | *No description.* | | WRITE_ERROR | *No description.* | | EXPIRED | *No description.* | | KILLED | *No description.* | | BLOCKED | *No description.* | --- ##### `FAULT` --- ##### `ERROR` --- ##### `SYSTEM_ERROR` --- ##### `USER_ERROR` --- ##### `FAILURE` --- ##### `ABORTED` --- ##### `THROTTLED` --- ##### `TIMED_OUT` --- ##### `READ_ERROR` --- ##### `WRITE_ERROR` --- ##### `EXPIRED` --- ##### `KILLED` --- ##### `BLOCKED` --- ### FluentBitFilterMetricTag #### Members | **Name** | **Description** | | --- | --- | | FILTER_EMIT_RECORDS | *No description.* | | FILTER_DROP_RECORDS | *No description.* | | FILTER_ADD_RECORDS | *No description.* | --- ##### `FILTER_EMIT_RECORDS` --- ##### `FILTER_DROP_RECORDS` --- ##### `FILTER_ADD_RECORDS` --- ### FluentBitInputMetricTag #### Members | **Name** | **Description** | | --- | --- | | INPUT_RECORDS | *No description.* | --- ##### `INPUT_RECORDS` --- ### FluentBitMetricsWithoutWidget #### Members | **Name** | **Description** | | --- | --- | | INPUT_BYTES | *No description.* | | OUTPUT_PROC_RECORDS | *No description.* | | OUTPUT_PROC_BYTES | *No description.* | --- ##### `INPUT_BYTES` --- ##### `OUTPUT_PROC_RECORDS` --- ##### `OUTPUT_PROC_BYTES` --- ### FluentBitOutputMetricTag #### Members | **Name** | **Description** | | --- | --- | | OUTPUT_RETRIES | *No description.* | | OUTPUT_RETRIES_FAILED | *No description.* | | OUTPUT_ERRORS | *No description.* | | OUTPUT_DROPPED_RECORDS | *No description.* | --- ##### `OUTPUT_RETRIES` --- ##### `OUTPUT_RETRIES_FAILED` --- ##### `OUTPUT_ERRORS` --- ##### `OUTPUT_DROPPED_RECORDS` --- ### FluentBitStorageMetricTag #### Members | **Name** | **Description** | | --- | --- | | TOTAL_CHUNKS | *No description.* | | MEM_CHUNKS | *No description.* | | FS_CHUNKS | *No description.* | | FS_CHUNKS_UP | *No description.* | | FS_CHUNKS_DOWN | *No description.* | --- ##### `TOTAL_CHUNKS` --- ##### `MEM_CHUNKS` --- ##### `FS_CHUNKS` --- ##### `FS_CHUNKS_UP` --- ##### `FS_CHUNKS_DOWN` --- ### GraphWidgetType #### Members | **Name** | **Description** | | --- | --- | | BAR | *No description.* | | LINE | *No description.* | | PIE | *No description.* | | SINGLE_VALUE | *No description.* | | STACKED_AREA | *No description.* | | TABLE | *No description.* | --- ##### `BAR` --- ##### `LINE` --- ##### `PIE` --- ##### `SINGLE_VALUE` --- ##### `STACKED_AREA` --- ##### `TABLE` --- ### HeaderLevel #### Members | **Name** | **Description** | | --- | --- | | LARGE | *No description.* | | MEDIUM | *No description.* | | SMALL | *No description.* | --- ##### `LARGE` --- ##### `MEDIUM` --- ##### `SMALL` --- ### LatencyType #### Members | **Name** | **Description** | | --- | --- | | P50 | *No description.* | | P70 | *No description.* | | P90 | *No description.* | | P95 | *No description.* | | P99 | *No description.* | | P999 | *No description.* | | P9999 | *No description.* | | P100 | *No description.* | | TM50 | *No description.* | | TM70 | *No description.* | | TM90 | *No description.* | | TM95 | *No description.* | | TM99 | *No description.* | | TM999 | *No description.* | | TM9999 | *No description.* | | TM95_TOP | *No description.* | | TM99_TOP | *No description.* | | TM999_TOP | *No description.* | | TM9999_TOP | *No description.* | | AVERAGE | *No description.* | | MAX | *No description.* | --- ##### `P50` --- ##### `P70` --- ##### `P90` --- ##### `P95` --- ##### `P99` --- ##### `P999` --- ##### `P9999` --- ##### `P100` --- ##### `TM50` --- ##### `TM70` --- ##### `TM90` --- ##### `TM95` --- ##### `TM99` --- ##### `TM999` --- ##### `TM9999` --- ##### `TM95_TOP` --- ##### `TM99_TOP` --- ##### `TM999_TOP` --- ##### `TM9999_TOP` --- ##### `AVERAGE` --- ##### `MAX` --- ### LogLevel Level of a given log. #### Members | **Name** | **Description** | | --- | --- | | ERROR | *No description.* | | CRITICAL | *No description.* | | FATAL | *No description.* | --- ##### `ERROR` --- ##### `CRITICAL` --- ##### `FATAL` --- ### MetricStatistic Metric aggregation statistic to be used with the IMetric objects. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html) #### Members | **Name** | **Description** | | --- | --- | | P50 | 50th percentile of all datapoints. | | P70 | 70th percentile of all datapoints. | | P90 | 90th percentile of all datapoints. | | P95 | 95th percentile of all datapoints. | | P99 | 99th percentile of all datapoints. | | P999 | 99.9th percentile of all datapoints. | | P9999 | 99.99th percentile of all datapoints. | | P100 | 100th percentile of all datapoints. | | TM50 | trimmed mean; | | TM70 | trimmed mean; | | TM90 | trimmed mean; | | TM95 | trimmed mean; | | TM99 | trimmed mean; | | TM999 | trimmed mean; | | TM9999 | trimmed mean; | | TM99_BOTH | trimmed mean; | | TM95_BOTH | trimmed mean; | | TM90_BOTH | trimmed mean; | | TM85_BOTH | trimmed mean; | | TM80_BOTH | trimmed mean; | | TM75_BOTH | trimmed mean; | | TM70_BOTH | trimmed mean; | | TM95_TOP | trimmed mean; | | TM99_TOP | trimmed mean; | | TM999_TOP | trimmed mean; | | TM9999_TOP | trimmed mean; | | WM50 | winsorized mean; | | WM70 | winsorized mean; | | WM90 | winsorized mean; | | WM95 | winsorized mean; | | WM99 | winsorized mean; | | WM999 | winsorized mean; | | WM9999 | winsorized mean; | | WM99_BOTH | winsorized mean; | | WM95_BOTH | winsorized mean; | | WM90_BOTH | winsorized mean; | | WM85_BOTH | winsorized mean; | | WM80_BOTH | winsorized mean; | | WM75_BOTH | winsorized mean; | | WM70_BOTH | winsorized mean; | | MIN | minimum of all datapoints. | | MAX | maximum of all datapoints. | | SUM | sum of all datapoints. | | AVERAGE | average of all datapoints. | | N | number of datapoints. | --- ##### `P50` 50th percentile of all datapoints. --- ##### `P70` 70th percentile of all datapoints. --- ##### `P90` 90th percentile of all datapoints. --- ##### `P95` 95th percentile of all datapoints. --- ##### `P99` 99th percentile of all datapoints. --- ##### `P999` 99.9th percentile of all datapoints. --- ##### `P9999` 99.99th percentile of all datapoints. --- ##### `P100` 100th percentile of all datapoints. --- ##### `TM50` trimmed mean; calculates the average after removing the 50% of data points with the highest values --- ##### `TM70` trimmed mean; calculates the average after removing the 30% of data points with the highest values --- ##### `TM90` trimmed mean; calculates the average after removing the 10% of data points with the highest values --- ##### `TM95` trimmed mean; calculates the average after removing the 5% of data points with the highest values --- ##### `TM99` trimmed mean; calculates the average after removing the 1% of data points with the highest values --- ##### `TM999` trimmed mean; calculates the average after removing the 0.1% of data points with the highest values --- ##### `TM9999` trimmed mean; calculates the average after removing the 0.01% of data points with the highest values --- ##### `TM99_BOTH` trimmed mean; calculates the average after removing the 1% lowest data points and the 1% highest data points --- ##### `TM95_BOTH` trimmed mean; calculates the average after removing the 5% lowest data points and the 5% highest data points --- ##### `TM90_BOTH` trimmed mean; calculates the average after removing the 10% lowest data points and the 10% highest data points --- ##### `TM85_BOTH` trimmed mean; calculates the average after removing the 15% lowest data points and the 15% highest data points --- ##### `TM80_BOTH` trimmed mean; calculates the average after removing the 20% lowest data points and the 20% highest data points --- ##### `TM75_BOTH` trimmed mean; calculates the average after removing the 25% lowest data points and the 25% highest data points --- ##### `TM70_BOTH` trimmed mean; calculates the average after removing the 30% lowest data points and the 30% highest data points --- ##### `TM95_TOP` trimmed mean; calculates the average after removing the 95% lowest data points --- ##### `TM99_TOP` trimmed mean; calculates the average after removing the 99% lowest data points --- ##### `TM999_TOP` trimmed mean; calculates the average after removing the 99.9% lowest data points --- ##### `TM9999_TOP` trimmed mean; calculates the average after removing the 99.99% lowest data points --- ##### `WM50` winsorized mean; calculates the average while treating the 50% of the highest values to be equal to the value at the 50th percentile --- ##### `WM70` winsorized mean; calculates the average while treating the 30% of the highest values to be equal to the value at the 70th percentile --- ##### `WM90` winsorized mean; calculates the average while treating the 10% of the highest values to be equal to the value at the 90th percentile --- ##### `WM95` winsorized mean; calculates the average while treating the 5% of the highest values to be equal to the value at the 95th percentile --- ##### `WM99` winsorized mean; calculates the average while treating the 1% of the highest values to be equal to the value at the 99th percentile --- ##### `WM999` winsorized mean; calculates the average while treating the 0.1% of the highest values to be equal to the value at the 99.9th percentile --- ##### `WM9999` winsorized mean; calculates the average while treating the 0.01% of the highest values to be equal to the value at the 99.99th percentile --- ##### `WM99_BOTH` winsorized mean; calculates the average while treating the highest 1% of data points to be the value of the 99% boundary, and treating the lowest 1% of data points to be the value of the 1% boundary --- ##### `WM95_BOTH` winsorized mean; calculates the average while treating the highest 5% of data points to be the value of the 95% boundary, and treating the lowest 5% of data points to be the value of the 5% boundary --- ##### `WM90_BOTH` winsorized mean; calculates the average while treating the highest 10% of data points to be the value of the 90% boundary, and treating the lowest 10% of data points to be the value of the 10% boundary --- ##### `WM85_BOTH` winsorized mean; calculates the average while treating the highest 15% of data points to be the value of the 85% boundary, and treating the lowest 15% of data points to be the value of the 15% boundary --- ##### `WM80_BOTH` winsorized mean; calculates the average while treating the highest 20% of data points to be the value of the 80% boundary, and treating the lowest 20% of data points to be the value of the 20% boundary --- ##### `WM75_BOTH` winsorized mean; calculates the average while treating the highest 25% of data points to be the value of the 75% boundary, and treating the lowest 25% of data points to be the value of the 25% boundary --- ##### `WM70_BOTH` winsorized mean; calculates the average while treating the highest 30% of data points to be the value of the 70% boundary, and treating the lowest 30% of data points to be the value of the 30% boundary --- ##### `MIN` minimum of all datapoints. --- ##### `MAX` maximum of all datapoints. --- ##### `SUM` sum of all datapoints. --- ##### `AVERAGE` average of all datapoints. --- ##### `N` number of datapoints. --- ### OpenSearchClusterStatus #### Members | **Name** | **Description** | | --- | --- | | RED | *No description.* | | YELLOW | *No description.* | --- ##### `RED` --- ##### `YELLOW` --- ### RateComputationMethod Enumeration of different rate computation methods. #### Members | **Name** | **Description** | | --- | --- | | AVERAGE | Number of occurrences relative to requests. | | PER_SECOND | Number of occurrences per second. | | PER_MINUTE | Number of occurrences per minute. | | PER_HOUR | Number of occurrences per hour. | | PER_DAY | Number of occurrences per day. | --- ##### `AVERAGE` Number of occurrences relative to requests. Less sensitive than per-second when TPS > 1. --- ##### `PER_SECOND` Number of occurrences per second. More sensitive than average when TPS > 1. --- ##### `PER_MINUTE` Number of occurrences per minute. --- ##### `PER_HOUR` Number of occurrences per hour. --- ##### `PER_DAY` Number of occurrences per day. --- ### StorageType #### Members | **Name** | **Description** | | --- | --- | | DEEP_ARCHIVE_OBJECT_OVERHEAD | *No description.* | | DEEP_ARCHIVE_S3_OBJECT_OVERHEAD | *No description.* | | DEEP_ARCHIVE_STAGING_STORAGE | *No description.* | | DEEP_ARCHIVE_STORAGE | *No description.* | | GLACIER_OBJECT_OVERHEAD | *No description.* | | GLACIER_S3_OBJECT_OVERHEAD | *No description.* | | GLACIER_STAGING_STORAGE | *No description.* | | GLACIER_STORAGE | *No description.* | | INTELLIGENT_TIERING_FA_STORAGE | *No description.* | | INTELLIGENT_TIERING_IA_STORAGE | *No description.* | | ONE_ZONE_IA_SIZE_OVERHEAD | *No description.* | | ONE_ZONE_IA_STORAGE | *No description.* | | REDUCED_REDUNDANCY_STORAGE | *No description.* | | STANDARD_IA_SIZE_OVERHEAD | *No description.* | | STANDARD_IA_STORAGE | *No description.* | | STANDARD_STORAGE | *No description.* | --- ##### `DEEP_ARCHIVE_OBJECT_OVERHEAD` --- ##### `DEEP_ARCHIVE_S3_OBJECT_OVERHEAD` --- ##### `DEEP_ARCHIVE_STAGING_STORAGE` --- ##### `DEEP_ARCHIVE_STORAGE` --- ##### `GLACIER_OBJECT_OVERHEAD` --- ##### `GLACIER_S3_OBJECT_OVERHEAD` --- ##### `GLACIER_STAGING_STORAGE` --- ##### `GLACIER_STORAGE` --- ##### `INTELLIGENT_TIERING_FA_STORAGE` --- ##### `INTELLIGENT_TIERING_IA_STORAGE` --- ##### `ONE_ZONE_IA_SIZE_OVERHEAD` --- ##### `ONE_ZONE_IA_STORAGE` --- ##### `REDUCED_REDUNDANCY_STORAGE` --- ##### `STANDARD_IA_SIZE_OVERHEAD` --- ##### `STANDARD_IA_STORAGE` --- ##### `STANDARD_STORAGE` --- ### UsageType #### Members | **Name** | **Description** | | --- | --- | | P50 | *No description.* | | P70 | *No description.* | | P90 | *No description.* | | P99 | *No description.* | | P999 | *No description.* | | P9999 | *No description.* | | P100 | *No description.* | | AVERAGE | *No description.* | | MAX | *No description.* | --- ##### `P50` --- ##### `P70` --- ##### `P90` --- ##### `P99` --- ##### `P999` --- ##### `P9999` --- ##### `P100` --- ##### `AVERAGE` --- ##### `MAX` ---