# API Reference ## Constructs ### ApiGatewayRestApi4XXErrorAlarm This alarm detects a high number of client-side errors. This can indicate an issue in the authorization or client request parameters. It could also mean that a resource was removed or a client is requesting one that doesn't exist. Consider enabling CloudWatch Logs and checking for any errors that may be causing the 4XX errors. Moreover, consider enabling detailed CloudWatch metrics to view this metric per resource and method and narrow down the source of the errors. Errors could also be caused by exceeding the configured throttling limit. The alarm is triggered when number of client-errors exceeds the threshold. #### Initializers ```typescript import { ApiGatewayRestApi4XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApiGatewayRestApi4XXErrorAlarm(scope: IConstruct, id: string, props: ApiGatewayRestApi4XXErrorAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApiGatewayRestApi4XXErrorAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApiGatewayRestApi4XXErrorAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApiGatewayRestApi4XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi4XXErrorAlarm.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 { ApiGatewayRestApi4XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi4XXErrorAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApiGatewayRestApi4XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi4XXErrorAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApiGatewayRestApi4XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi4XXErrorAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApiGatewayRestApi4XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi4XXErrorAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApiGatewayRestApi5XXErrorAlarm This alarm detects a high number of server-side errors. This can indicate that there is something wrong on the API backend, the network, or the integration between the API gateway and the backend API. The alarm is triggered when number of server-errors exceeds the threshold. #### Initializers ```typescript import { ApiGatewayRestApi5XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApiGatewayRestApi5XXErrorAlarm(scope: IConstruct, id: string, props: ApiGatewayRestApi5XXErrorAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApiGatewayRestApi5XXErrorAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApiGatewayRestApi5XXErrorAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApiGatewayRestApi5XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi5XXErrorAlarm.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 { ApiGatewayRestApi5XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi5XXErrorAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApiGatewayRestApi5XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi5XXErrorAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApiGatewayRestApi5XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi5XXErrorAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApiGatewayRestApi5XXErrorAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApi5XXErrorAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApiGatewayRestApiCountAnomalyAlarm An anomaly detection alarm on the API Gateway `Count` metric. AWS recommends a static `Count` alarm with `LESS_THAN_THRESHOLD` to detect unexpected traffic drops, but says the threshold "Depends on your situation". This anomaly variant lets the band track historical traffic so the alarm fires on actual deviations without picking a number that goes stale. By default it flags both unexpected drops and unusual spikes (e.g. abuse or retry storms). Because anomaly detection requires the `Average` statistic, this alarm tracks the average request rate per period, not total request volume. Note: on the drop side it detects partial drops below the expected band, not a complete outage. API Gateway does not publish `Count` when there are zero requests, so a full outage produces missing data (treated as not breaching) rather than a low value. To alarm on zero traffic, pair this with a static `Count` alarm or a canary. #### Initializers ```typescript import { ApiGatewayRestApiCountAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApiGatewayRestApiCountAnomalyAlarm(scope: IConstruct, id: string, props: ApiGatewayRestApiCountAnomalyAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApiGatewayRestApiCountAnomalyAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApiGatewayRestApiCountAnomalyAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApiGatewayRestApiCountAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiCountAnomalyAlarm.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 { ApiGatewayRestApiCountAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiCountAnomalyAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApiGatewayRestApiCountAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiCountAnomalyAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApiGatewayRestApiCountAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiCountAnomalyAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApiGatewayRestApiCountAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiCountAnomalyAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApiGatewayRestApiDetailedLatencyAlarm This alarm detects high latency for a resource and method in a stage. Find the IntegrationLatency metric value to check the API backend latency. If the two metrics are mostly aligned, the API backend is the source of higher latency and you should investigate there for performance issues. Consider also enabling CloudWatch Logs and checking for any errors that might be causing the high latency. The alarm is triggered when time in milliseconds exceeds or equals the threshold. #### Initializers ```typescript import { ApiGatewayRestApiDetailedLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApiGatewayRestApiDetailedLatencyAlarm(scope: IConstruct, id: string, props: ApiGatewayRestApiDetailedLatencyAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApiGatewayRestApiDetailedLatencyAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApiGatewayRestApiDetailedLatencyAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApiGatewayRestApiDetailedLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiDetailedLatencyAlarm.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 { ApiGatewayRestApiDetailedLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiDetailedLatencyAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApiGatewayRestApiDetailedLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiDetailedLatencyAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApiGatewayRestApiDetailedLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiDetailedLatencyAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApiGatewayRestApiDetailedLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiDetailedLatencyAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApiGatewayRestApiIntegrationLatencyAnomalyAlarm An anomaly detection alarm on the API Gateway `IntegrationLatency` metric. Catches drift in backend latency separately from total request latency, so a slow backend integration shows up even when overall request latency is within normal range (e.g. because backend latency was always part of the baseline). This library has no static counterpart for this metric. #### Initializers ```typescript import { ApiGatewayRestApiIntegrationLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApiGatewayRestApiIntegrationLatencyAnomalyAlarm(scope: IConstruct, id: string, props: ApiGatewayRestApiIntegrationLatencyAnomalyAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApiGatewayRestApiIntegrationLatencyAnomalyAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApiGatewayRestApiIntegrationLatencyAnomalyAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApiGatewayRestApiIntegrationLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiIntegrationLatencyAnomalyAlarm.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 { ApiGatewayRestApiIntegrationLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiIntegrationLatencyAnomalyAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApiGatewayRestApiIntegrationLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiIntegrationLatencyAnomalyAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApiGatewayRestApiIntegrationLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiIntegrationLatencyAnomalyAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApiGatewayRestApiIntegrationLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiIntegrationLatencyAnomalyAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApiGatewayRestApiLatencyAlarm This alarm can detect when the API Gateway requests in a stage have high latency. If you have detailed CloudWatch metrics enabled and you have different latency performance requirements for each method and resource, we recommend that you create alternative alarms to have more fine-grained monitoring of the latency for each resource and method. The alarm is triggered when time in milliseconds exceeds or equals the threshold. #### Initializers ```typescript import { ApiGatewayRestApiLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApiGatewayRestApiLatencyAlarm(scope: IConstruct, id: string, props: ApiGatewayRestApiLatencyAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApiGatewayRestApiLatencyAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApiGatewayRestApiLatencyAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApiGatewayRestApiLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAlarm.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 { ApiGatewayRestApiLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApiGatewayRestApiLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApiGatewayRestApiLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApiGatewayRestApiLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApiGatewayRestApiLatencyAnomalyAlarm An anomaly detection alarm on the API Gateway `Latency` metric. Catches drift in total request latency without requiring a static threshold. The static `Latency` alarm uses the AWS-recommended `p90` statistic and a fixed threshold; this anomaly variant uses `Average` (required by anomaly detection) and a CloudWatch-fitted band. It is intended to coexist with the static alarm, not replace it. #### Initializers ```typescript import { ApiGatewayRestApiLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApiGatewayRestApiLatencyAnomalyAlarm(scope: IConstruct, id: string, props: ApiGatewayRestApiLatencyAnomalyAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApiGatewayRestApiLatencyAnomalyAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApiGatewayRestApiLatencyAnomalyAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApiGatewayRestApiLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAnomalyAlarm.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 { ApiGatewayRestApiLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAnomalyAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApiGatewayRestApiLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAnomalyAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApiGatewayRestApiLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAnomalyAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApiGatewayRestApiLatencyAnomalyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiLatencyAnomalyAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApiGatewayRestApiRecommendedAlarms A construct that creates the recommended alarms for an ApiGateway api. The recommended alarms created by default for the ApiName and Stage are: - 4XXError alarm - 5XXError alarm - Latency alarm - Latency anomaly detection alarm (additional to the static Latency alarm) - Count anomaly detection alarm (drop detection for low-traffic APIs) - IntegrationLatency anomaly detection alarm (no static counterpart) In order to create the Latency alarms for the Resource and Method dimensions the configDetailedLatencyAlarmList must be specified. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway) #### Initializers ```typescript import { ApiGatewayRestApiRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApiGatewayRestApiRecommendedAlarms(scope: Construct, id: string, props: ApiGatewayRestApiRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ApiGatewayRestApiRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApiGatewayRestApiRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { ApiGatewayRestApiRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApiGatewayRestApiRecommendedAlarms.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. | | alarm4XXError | ApiGatewayRestApi4XXErrorAlarm | The 4XXError alarm. | | alarm5XXError | ApiGatewayRestApi5XXErrorAlarm | The 5XXError alarm. | | alarmCountAnomaly | ApiGatewayRestApiCountAnomalyAlarm | The Count anomaly detection alarm. | | alarmIntegrationLatencyAnomaly | ApiGatewayRestApiIntegrationLatencyAnomalyAlarm | The IntegrationLatency anomaly detection alarm. | | alarmLatency | ApiGatewayRestApiLatencyAlarm | The Latency alarm. | | alarmLatencyAnomaly | ApiGatewayRestApiLatencyAnomalyAlarm | The Latency anomaly detection alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarm4XXError`^Optional ```typescript public readonly alarm4XXError: ApiGatewayRestApi4XXErrorAlarm; ``` - *Type:* ApiGatewayRestApi4XXErrorAlarm The 4XXError alarm. --- ##### `alarm5XXError`^Optional ```typescript public readonly alarm5XXError: ApiGatewayRestApi5XXErrorAlarm; ``` - *Type:* ApiGatewayRestApi5XXErrorAlarm The 5XXError alarm. --- ##### `alarmCountAnomaly`^Optional ```typescript public readonly alarmCountAnomaly: ApiGatewayRestApiCountAnomalyAlarm; ``` - *Type:* ApiGatewayRestApiCountAnomalyAlarm The Count anomaly detection alarm. --- ##### `alarmIntegrationLatencyAnomaly`^Optional ```typescript public readonly alarmIntegrationLatencyAnomaly: ApiGatewayRestApiIntegrationLatencyAnomalyAlarm; ``` - *Type:* ApiGatewayRestApiIntegrationLatencyAnomalyAlarm The IntegrationLatency anomaly detection alarm. --- ##### `alarmLatency`^Optional ```typescript public readonly alarmLatency: ApiGatewayRestApiLatencyAlarm; ``` - *Type:* ApiGatewayRestApiLatencyAlarm The Latency alarm. --- ##### `alarmLatencyAnomaly`^Optional ```typescript public readonly alarmLatencyAnomaly: ApiGatewayRestApiLatencyAnomalyAlarm; ``` - *Type:* ApiGatewayRestApiLatencyAnomalyAlarm The Latency anomaly detection alarm. --- ### ApplicationLoadBalancer An extension for the ApplicationLoadBalancer construct that provides methods to create recommended alarms. #### Initializers ```typescript import { ApplicationLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationLoadBalancer(scope: Construct, id: string, props: ApplicationLoadBalancerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancerProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancerProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | logAccessLogs | Enable access logging for this load balancer. | | removeAttribute | Remove an attribute from the load balancer. | | setAttribute | Set a non-standard attribute on the load balancer. | | addListener | Add a new listener to this load balancer. | | addRedirect | Add a redirection listener to this load balancer. | | addSecurityGroup | Add a security group to this load balancer. | | logConnectionLogs | Enable connection logging for this load balancer. | | metric | Return the given named metric for this Application Load Balancer. | | metricActiveConnectionCount | The total number of concurrent TCP connections active from clients to the load balancer and from the load balancer to targets. | | metricClientTlsNegotiationErrorCount | The number of TLS connections initiated by the client that did not establish a session with the load balancer. | | metricConsumedLCUs | The number of load balancer capacity units (LCU) used by your load balancer. | | metricElbAuthError | The number of user authentications that could not be completed. | | metricElbAuthFailure | The number of user authentications that could not be completed because the IdP denied access to the user or an authorization code was used more than once. | | metricElbAuthLatency | The time elapsed, in milliseconds, to query the IdP for the ID token and user info. | | metricElbAuthSuccess | The number of authenticate actions that were successful. | | metricHttpCodeElb | The number of HTTP 3xx/4xx/5xx codes that originate from the load balancer. | | metricHttpCodeTarget | The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in the load balancer. | | metricHttpFixedResponseCount | The number of fixed-response actions that were successful. | | metricHttpRedirectCount | The number of redirect actions that were successful. | | metricHttpRedirectUrlLimitExceededCount | The number of redirect actions that couldn't be completed because the URL in the response location header is larger than 8K. | | metricIpv6ProcessedBytes | The total number of bytes processed by the load balancer over IPv6. | | metricIpv6RequestCount | The number of IPv6 requests received by the load balancer. | | metricNewConnectionCount | The total number of new TCP connections established from clients to the load balancer and from the load balancer to targets. | | metricProcessedBytes | The total number of bytes processed by the load balancer over IPv4 and IPv6. | | metricRejectedConnectionCount | The number of connections that were rejected because the load balancer had reached its maximum number of connections. | | metricRequestCount | The number of requests processed over IPv4 and IPv6. | | metricRuleEvaluations | The number of rules processed by the load balancer given a request rate averaged over an hour. | | metricTargetConnectionErrorCount | The number of connections that were not successfully established between the load balancer and target. | | metricTargetResponseTime | The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received. | | metricTargetTLSNegotiationErrorCount | The number of TLS connections initiated by the load balancer that did not establish a session with the target. | | alarmHttpCode4xxCount | Creates an alarm that monitors the HTTP 4XX error count for the ApplicationLoadBalancer. | | alarmHttpCode5xxCount | Creates an alarm that monitors the HTTP 5XX error count for the ApplicationLoadBalancer. | | alarmHttpCodeTarget5xxCount | Creates an alarm that monitors the HTTP 5XX error count from targets for the ApplicationLoadBalancer. | | alarmRejectedConnectionCount | Creates an alarm that monitors the rejected connection count for the ApplicationLoadBalancer. | | applyRecommendedAlarms | Creates the recommended alarms for the ApplicationLoadBalancer. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `logAccessLogs` ```typescript public logAccessLogs(bucket: IBucket, prefix?: string): void ``` Enable access logging for this load balancer. A region must be specified on the stack containing the load balancer; you cannot enable logging on environment-agnostic stacks. See https://docs.aws.amazon.com/cdk/latest/guide/environments.html ###### `bucket`^Required - *Type:* aws-cdk-lib.aws_s3.IBucket --- ###### `prefix`^Optional - *Type:* string --- ##### `removeAttribute` ```typescript public removeAttribute(key: string): void ``` Remove an attribute from the load balancer. ###### `key`^Required - *Type:* string --- ##### `setAttribute` ```typescript public setAttribute(key: string, value?: string): void ``` Set a non-standard attribute on the load balancer. > [https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes) ###### `key`^Required - *Type:* string --- ###### `value`^Optional - *Type:* string --- ##### `addListener` ```typescript public addListener(id: string, props: BaseApplicationListenerProps): ApplicationListener ``` Add a new listener to this load balancer. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.BaseApplicationListenerProps --- ##### `addRedirect` ```typescript public addRedirect(props?: ApplicationLoadBalancerRedirectConfig): ApplicationListener ``` Add a redirection listener to this load balancer. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancerRedirectConfig --- ##### `addSecurityGroup` ```typescript public addSecurityGroup(securityGroup: ISecurityGroup): void ``` Add a security group to this load balancer. ###### `securityGroup`^Required - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup --- ##### `logConnectionLogs` ```typescript public logConnectionLogs(bucket: IBucket, prefix?: string): void ``` Enable connection logging for this load balancer. A region must be specified on the stack containing the load balancer; you cannot enable logging on environment-agnostic stacks. > [https://docs.aws.amazon.com/cdk/latest/guide/environments.html](https://docs.aws.amazon.com/cdk/latest/guide/environments.html) ###### `bucket`^Required - *Type:* aws-cdk-lib.aws_s3.IBucket --- ###### `prefix`^Optional - *Type:* string --- ##### ~~`metric`~~ ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Application Load Balancer. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricActiveConnectionCount`~~ ```typescript public metricActiveConnectionCount(props?: MetricOptions): Metric ``` The total number of concurrent TCP connections active from clients to the load balancer and from the load balancer to targets. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricClientTlsNegotiationErrorCount`~~ ```typescript public metricClientTlsNegotiationErrorCount(props?: MetricOptions): Metric ``` The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricConsumedLCUs`~~ ```typescript public metricConsumedLCUs(props?: MetricOptions): Metric ``` The number of load balancer capacity units (LCU) used by your load balancer. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricElbAuthError`~~ ```typescript public metricElbAuthError(props?: MetricOptions): Metric ``` The number of user authentications that could not be completed. Because an authenticate action was misconfigured, the load balancer couldn't establish a connection with the IdP, or the load balancer couldn't complete the authentication flow due to an internal error. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricElbAuthFailure`~~ ```typescript public metricElbAuthFailure(props?: MetricOptions): Metric ``` The number of user authentications that could not be completed because the IdP denied access to the user or an authorization code was used more than once. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricElbAuthLatency`~~ ```typescript public metricElbAuthLatency(props?: MetricOptions): Metric ``` The time elapsed, in milliseconds, to query the IdP for the ID token and user info. If one or more of these operations fail, this is the time to failure. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricElbAuthSuccess`~~ ```typescript public metricElbAuthSuccess(props?: MetricOptions): Metric ``` The number of authenticate actions that were successful. This metric is incremented at the end of the authentication workflow, after the load balancer has retrieved the user claims from the IdP. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricHttpCodeElb`~~ ```typescript public metricHttpCodeElb(code: HttpCodeElb, props?: MetricOptions): Metric ``` The number of HTTP 3xx/4xx/5xx codes that originate from the load balancer. This does not include any response codes generated by the targets. ###### `code`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.HttpCodeElb --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricHttpCodeTarget`~~ ```typescript public metricHttpCodeTarget(code: HttpCodeTarget, props?: MetricOptions): Metric ``` The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in the load balancer. This does not include any response codes generated by the load balancer. ###### `code`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.HttpCodeTarget --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricHttpFixedResponseCount`~~ ```typescript public metricHttpFixedResponseCount(props?: MetricOptions): Metric ``` The number of fixed-response actions that were successful. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricHttpRedirectCount`~~ ```typescript public metricHttpRedirectCount(props?: MetricOptions): Metric ``` The number of redirect actions that were successful. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricHttpRedirectUrlLimitExceededCount`~~ ```typescript public metricHttpRedirectUrlLimitExceededCount(props?: MetricOptions): Metric ``` The number of redirect actions that couldn't be completed because the URL in the response location header is larger than 8K. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricIpv6ProcessedBytes`~~ ```typescript public metricIpv6ProcessedBytes(props?: MetricOptions): Metric ``` The total number of bytes processed by the load balancer over IPv6. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricIpv6RequestCount`~~ ```typescript public metricIpv6RequestCount(props?: MetricOptions): Metric ``` The number of IPv6 requests received by the load balancer. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricNewConnectionCount`~~ ```typescript public metricNewConnectionCount(props?: MetricOptions): Metric ``` The total number of new TCP connections established from clients to the load balancer and from the load balancer to targets. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricProcessedBytes`~~ ```typescript public metricProcessedBytes(props?: MetricOptions): Metric ``` The total number of bytes processed by the load balancer over IPv4 and IPv6. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricRejectedConnectionCount`~~ ```typescript public metricRejectedConnectionCount(props?: MetricOptions): Metric ``` The number of connections that were rejected because the load balancer had reached its maximum number of connections. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricRequestCount`~~ ```typescript public metricRequestCount(props?: MetricOptions): Metric ``` The number of requests processed over IPv4 and IPv6. This count includes only the requests with a response generated by a target of the load balancer. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricRuleEvaluations`~~ ```typescript public metricRuleEvaluations(props?: MetricOptions): Metric ``` The number of rules processed by the load balancer given a request rate averaged over an hour. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricTargetConnectionErrorCount`~~ ```typescript public metricTargetConnectionErrorCount(props?: MetricOptions): Metric ``` The number of connections that were not successfully established between the load balancer and target. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricTargetResponseTime`~~ ```typescript public metricTargetResponseTime(props?: MetricOptions): Metric ``` The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricTargetTLSNegotiationErrorCount`~~ ```typescript public metricTargetTLSNegotiationErrorCount(props?: MetricOptions): Metric ``` The number of TLS connections initiated by the load balancer that did not establish a session with the target. Possible causes include a mismatch of ciphers or protocols. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `alarmHttpCode4xxCount` ```typescript public alarmHttpCode4xxCount(props?: ApplicationLoadBalancerHttpCode4xxCountAlarmConfig): ApplicationLoadBalancerHttpCode4xxCountAlarm ``` Creates an alarm that monitors the HTTP 4XX error count for the ApplicationLoadBalancer. ###### `props`^Optional - *Type:* ApplicationLoadBalancerHttpCode4xxCountAlarmConfig --- ##### `alarmHttpCode5xxCount` ```typescript public alarmHttpCode5xxCount(props?: ApplicationLoadBalancerHttpCode5xxCountAlarmConfig): ApplicationLoadBalancerHttpCode5xxCountAlarm ``` Creates an alarm that monitors the HTTP 5XX error count for the ApplicationLoadBalancer. ###### `props`^Optional - *Type:* ApplicationLoadBalancerHttpCode5xxCountAlarmConfig --- ##### `alarmHttpCodeTarget5xxCount` ```typescript public alarmHttpCodeTarget5xxCount(props?: ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig): ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm ``` Creates an alarm that monitors the HTTP 5XX error count from targets for the ApplicationLoadBalancer. ###### `props`^Optional - *Type:* ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig --- ##### `alarmRejectedConnectionCount` ```typescript public alarmRejectedConnectionCount(props?: ApplicationLoadBalancerRejectedConnectionCountAlarmConfig): ApplicationLoadBalancerRejectedConnectionCountAlarm ``` Creates an alarm that monitors the rejected connection count for the ApplicationLoadBalancer. ###### `props`^Optional - *Type:* ApplicationLoadBalancerRejectedConnectionCountAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: ApplicationLoadBalancerRecommendedAlarmsConfig): ApplicationLoadBalancerRecommendedAlarms ``` Creates the recommended alarms for the ApplicationLoadBalancer. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) ###### `props`^Required - *Type:* ApplicationLoadBalancerRecommendedAlarmsConfig --- #### 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. | | fromApplicationLoadBalancerAttributes | Import an existing Application Load Balancer. | | fromLookup | Look up an application load balancer. | --- ##### `isConstruct` ```typescript import { ApplicationLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancer.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 { ApplicationLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancer.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApplicationLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancer.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromApplicationLoadBalancerAttributes` ```typescript import { ApplicationLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancer.fromApplicationLoadBalancerAttributes(scope: Construct, id: string, attrs: ApplicationLoadBalancerAttributes) ``` Import an existing Application Load Balancer. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancerAttributes --- ##### `fromLookup` ```typescript import { ApplicationLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancer.fromLookup(scope: Construct, id: string, options: ApplicationLoadBalancerLookupOptions) ``` Look up an application load balancer. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancerLookupOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | loadBalancerArn | string | The ARN of this load balancer. | | loadBalancerCanonicalHostedZoneId | string | The canonical hosted zone ID of this load balancer. | | loadBalancerDnsName | string | The DNS name of this load balancer. | | loadBalancerFullName | string | The full name of this load balancer. | | loadBalancerName | string | The name of this load balancer. | | loadBalancerRef | aws-cdk-lib.interfaces.aws_elasticloadbalancingv2.LoadBalancerReference | A reference to this load balancer. | | loadBalancerSecurityGroups | string[] | *No description.* | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC this load balancer has been created in. | | connections | aws-cdk-lib.aws_ec2.Connections | The network connections associated with this resource. | | isApplicationLoadBalancer | boolean | Indicates that this is an Application Load Balancer. | | listeners | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener[] | A list of listeners that have been added to the load balancer. | | metrics | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancerMetrics | All metrics available for this load balancer. | | ipAddressType | aws-cdk-lib.aws_elasticloadbalancingv2.IpAddressType | The IP Address Type for this load balancer. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `loadBalancerArn`^Required ```typescript public readonly loadBalancerArn: string; ``` - *Type:* string The ARN of this load balancer. Example value: `arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/50dc6c495c0c9188` --- ##### `loadBalancerCanonicalHostedZoneId`^Required ```typescript public readonly loadBalancerCanonicalHostedZoneId: string; ``` - *Type:* string The canonical hosted zone ID of this load balancer. Example value: `Z2P70J7EXAMPLE` --- ##### `loadBalancerDnsName`^Required ```typescript public readonly loadBalancerDnsName: string; ``` - *Type:* string The DNS name of this load balancer. Example value: `my-load-balancer-424835706.us-west-2.elb.amazonaws.com` --- ##### `loadBalancerFullName`^Required ```typescript public readonly loadBalancerFullName: string; ``` - *Type:* string The full name of this load balancer. Example value: `app/my-load-balancer/50dc6c495c0c9188` --- ##### `loadBalancerName`^Required ```typescript public readonly loadBalancerName: string; ``` - *Type:* string The name of this load balancer. Example value: `my-load-balancer` --- ##### `loadBalancerRef`^Required ```typescript public readonly loadBalancerRef: LoadBalancerReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_elasticloadbalancingv2.LoadBalancerReference A reference to this load balancer. --- ##### `loadBalancerSecurityGroups`^Required ```typescript public readonly loadBalancerSecurityGroups: string[]; ``` - *Type:* string[] --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC this load balancer has been created in. This property is always defined (not `null` or `undefined`) for sub-classes of `BaseLoadBalancer`. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The network connections associated with this resource. --- ##### `isApplicationLoadBalancer`^Required ```typescript public readonly isApplicationLoadBalancer: boolean; ``` - *Type:* boolean Indicates that this is an Application Load Balancer. Will always return true, but is necessary to prevent accidental structural equality in TypeScript. --- ##### `listeners`^Required ```typescript public readonly listeners: ApplicationListener[]; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationListener[] A list of listeners that have been added to the load balancer. This list is only valid for owned constructs. --- ##### `metrics`^Required ```typescript public readonly metrics: IApplicationLoadBalancerMetrics; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancerMetrics All metrics available for this load balancer. --- ##### `ipAddressType`^Optional ```typescript public readonly ipAddressType: IpAddressType; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IpAddressType The IP Address Type for this load balancer. If the `@aws-cdk/aws-elasticloadbalancingV2:albDualstackWithoutPublicIpv4SecurityGroupRulesDefault` feature flag is set (the default for new projects), and `addListener()` is called with `open: true`, the load balancer's security group will automatically include both IPv4 and IPv6 ingress rules when using `IpAddressType.DUAL_STACK_WITHOUT_PUBLIC_IPV4`. For existing projects that only have IPv4 rules, you can opt-in to IPv6 ingress rules by enabling the feature flag in your cdk.json file. Note that enabling this feature flag will modify existing security group rules. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApplicationLoadBalancerHttpCode4xxCountAlarm This anomaly detection alarm is used to detect when the load balancer is generating unusually many 4XX errors. A high number of 4XX errors can indicate client-side issues or misconfigured requests. The alarm is triggered when the number of 4XX errors is outside the upper threshold of the anomaly detection band. #### Initializers ```typescript import { ApplicationLoadBalancerHttpCode4xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationLoadBalancerHttpCode4xxCountAlarm(scope: IConstruct, id: string, props: ApplicationLoadBalancerHttpCode4xxCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApplicationLoadBalancerHttpCode4xxCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApplicationLoadBalancerHttpCode4xxCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApplicationLoadBalancerHttpCode4xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode4xxCountAlarm.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 { ApplicationLoadBalancerHttpCode4xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode4xxCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApplicationLoadBalancerHttpCode4xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode4xxCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApplicationLoadBalancerHttpCode4xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode4xxCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApplicationLoadBalancerHttpCode4xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode4xxCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApplicationLoadBalancerHttpCode5xxCountAlarm This anomaly detection alarm is used to detect when the load balancer is generating unusually many 5XX errors. A high number of 5XX errors can indicate issues with the load balancer itself. The alarm is triggered when the number of 5XX errors is outside the upper threshold of the anomaly detection band. #### Initializers ```typescript import { ApplicationLoadBalancerHttpCode5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationLoadBalancerHttpCode5xxCountAlarm(scope: IConstruct, id: string, props: ApplicationLoadBalancerHttpCode5xxCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApplicationLoadBalancerHttpCode5xxCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApplicationLoadBalancerHttpCode5xxCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApplicationLoadBalancerHttpCode5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode5xxCountAlarm.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 { ApplicationLoadBalancerHttpCode5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode5xxCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApplicationLoadBalancerHttpCode5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode5xxCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApplicationLoadBalancerHttpCode5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode5xxCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApplicationLoadBalancerHttpCode5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCode5xxCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm This alarm is used to detect when the targets are generating 5XX errors. A high number of 5XX errors can indicate issues with the application or backend services. The alarm is triggered when the number of 5XX errors from targets is greater than threshold. #### Initializers ```typescript import { ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm(scope: IConstruct, id: string, props: ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm.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 { ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApplicationLoadBalancerRecommendedAlarms A construct that creates the recommended alarms for an ApplicationLoadBalancer. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) #### Initializers ```typescript import { ApplicationLoadBalancerRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationLoadBalancerRecommendedAlarms(scope: Construct, id: string, props: ApplicationLoadBalancerRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ApplicationLoadBalancerRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApplicationLoadBalancerRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { ApplicationLoadBalancerRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerRecommendedAlarms.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. | | alarmHttpCode4xxCount | ApplicationLoadBalancerHttpCode4xxCountAlarm | The HTTPCode_ELB_4XX_Count alarm. | | alarmHttpCode5xxCount | ApplicationLoadBalancerHttpCode5xxCountAlarm | The HTTPCode_ELB_5XX_Count alarm. | | alarmHttpCodeTarget5xxCount | ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm | The HTTPCode_Target_5XX_Count alarm. | | alarmRejectedConnectionCount | ApplicationLoadBalancerRejectedConnectionCountAlarm | The RejectedConnectionCount alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmHttpCode4xxCount`^Optional ```typescript public readonly alarmHttpCode4xxCount: ApplicationLoadBalancerHttpCode4xxCountAlarm; ``` - *Type:* ApplicationLoadBalancerHttpCode4xxCountAlarm The HTTPCode_ELB_4XX_Count alarm. --- ##### `alarmHttpCode5xxCount`^Optional ```typescript public readonly alarmHttpCode5xxCount: ApplicationLoadBalancerHttpCode5xxCountAlarm; ``` - *Type:* ApplicationLoadBalancerHttpCode5xxCountAlarm The HTTPCode_ELB_5XX_Count alarm. --- ##### `alarmHttpCodeTarget5xxCount`^Optional ```typescript public readonly alarmHttpCodeTarget5xxCount: ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm; ``` - *Type:* ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm The HTTPCode_Target_5XX_Count alarm. --- ##### `alarmRejectedConnectionCount`^Optional ```typescript public readonly alarmRejectedConnectionCount: ApplicationLoadBalancerRejectedConnectionCountAlarm; ``` - *Type:* ApplicationLoadBalancerRejectedConnectionCountAlarm The RejectedConnectionCount alarm. --- ### ApplicationLoadBalancerRejectedConnectionCountAlarm This alarm is used to detect when the load balancer is rejecting connections. Rejected connections can indicate that the load balancer has reached its maximum connection limit. The alarm is triggered when the number of rejected connections is greater than threshold. #### Initializers ```typescript import { ApplicationLoadBalancerRejectedConnectionCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationLoadBalancerRejectedConnectionCountAlarm(scope: IConstruct, id: string, props: ApplicationLoadBalancerRejectedConnectionCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApplicationLoadBalancerRejectedConnectionCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApplicationLoadBalancerRejectedConnectionCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApplicationLoadBalancerRejectedConnectionCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerRejectedConnectionCountAlarm.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 { ApplicationLoadBalancerRejectedConnectionCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerRejectedConnectionCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApplicationLoadBalancerRejectedConnectionCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerRejectedConnectionCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApplicationLoadBalancerRejectedConnectionCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerRejectedConnectionCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApplicationLoadBalancerRejectedConnectionCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationLoadBalancerRejectedConnectionCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApplicationTargetGroup An extension for the ApplicationTargetGroup construct that provides methods to create recommended alarms. #### Initializers ```typescript import { ApplicationTargetGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationTargetGroup(scope: Construct, id: string, props: ApplicationTargetGroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | configureHealthCheck | Set/replace the target group's health check. | | setAttribute | Set a non-standard attribute on the target group. | | addTarget | Add a load balancing target to this target group. | | enableCookieStickiness | Enable sticky routing via a cookie to members of this target group. | | metric | Return the given named metric for this Application Load Balancer Target Group. | | metricHealthyHostCount | The number of healthy hosts in the target group. | | metricHttpCodeTarget | The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in this target group. | | metricIpv6RequestCount | The number of IPv6 requests received by the target group. | | metricRequestCount | The number of requests processed over IPv4 and IPv6. | | metricRequestCountPerTarget | The average number of requests received by each target in a target group. | | metricTargetConnectionErrorCount | The number of connections that were not successfully established between the load balancer and target. | | metricTargetResponseTime | The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received. | | metricTargetTLSNegotiationErrorCount | The number of TLS connections initiated by the load balancer that did not establish a session with the target. | | metricUnhealthyHostCount | The number of unhealthy hosts in the target group. | | registerConnectable | Register a connectable as a member of this target group. | | registerListener | Register a listener that is load balancing to this target group. | | alarmHealthyHostCount | Creates an alarm that monitors the healthy host count for the ApplicationTargetGroup. | | alarmUnHealthyHostCount | Creates an alarm that monitors the unhealthy host count for the ApplicationTargetGroup. | | applyRecommendedAlarms | Creates the recommended alarms for the ApplicationTargetGroup. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `configureHealthCheck` ```typescript public configureHealthCheck(healthCheck: HealthCheck): void ``` Set/replace the target group's health check. ###### `healthCheck`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.HealthCheck --- ##### `setAttribute` ```typescript public setAttribute(key: string, value?: string): void ``` Set a non-standard attribute on the target group. > [https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes) ###### `key`^Required - *Type:* string --- ###### `value`^Optional - *Type:* string --- ##### `addTarget` ```typescript public addTarget(targets: ...IApplicationLoadBalancerTarget[]): void ``` Add a load balancing target to this target group. ###### `targets`^Required - *Type:* ...aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationLoadBalancerTarget[] --- ##### `enableCookieStickiness` ```typescript public enableCookieStickiness(duration: Duration, cookieName?: string): void ``` Enable sticky routing via a cookie to members of this target group. Note: If the `cookieName` parameter is set, application-based stickiness will be applied, otherwise it defaults to duration-based stickiness attributes (`lb_cookie`). > [https://docs.aws.amazon.com/elasticloadbalancing/latest/application/sticky-sessions.html](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/sticky-sessions.html) ###### `duration`^Required - *Type:* aws-cdk-lib.Duration --- ###### `cookieName`^Optional - *Type:* string --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Application Load Balancer Target Group. Returns the metric for this target group from the point of view of the first load balancer load balancing to it. If you have multiple load balancers load sending traffic to the same target group, you will have to override the dimensions on this metric. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricHealthyHostCount`~~ ```typescript public metricHealthyHostCount(props?: MetricOptions): Metric ``` The number of healthy hosts in the target group. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricHttpCodeTarget`~~ ```typescript public metricHttpCodeTarget(code: HttpCodeTarget, props?: MetricOptions): Metric ``` The number of HTTP 2xx/3xx/4xx/5xx response codes generated by all targets in this target group. This does not include any response codes generated by the load balancer. ###### `code`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.HttpCodeTarget --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricIpv6RequestCount`~~ ```typescript public metricIpv6RequestCount(props?: MetricOptions): Metric ``` The number of IPv6 requests received by the target group. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricRequestCount`~~ ```typescript public metricRequestCount(props?: MetricOptions): Metric ``` The number of requests processed over IPv4 and IPv6. This count includes only the requests with a response generated by a target of the load balancer. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricRequestCountPerTarget`~~ ```typescript public metricRequestCountPerTarget(props?: MetricOptions): Metric ``` The average number of requests received by each target in a target group. The only valid statistic is Sum. Note that this represents the average not the sum. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricTargetConnectionErrorCount`~~ ```typescript public metricTargetConnectionErrorCount(props?: MetricOptions): Metric ``` The number of connections that were not successfully established between the load balancer and target. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricTargetResponseTime`~~ ```typescript public metricTargetResponseTime(props?: MetricOptions): Metric ``` The time elapsed, in seconds, after the request leaves the load balancer until a response from the target is received. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricTargetTLSNegotiationErrorCount`~~ ```typescript public metricTargetTLSNegotiationErrorCount(props?: MetricOptions): Metric ``` The number of TLS connections initiated by the load balancer that did not establish a session with the target. Possible causes include a mismatch of ciphers or protocols. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricUnhealthyHostCount`~~ ```typescript public metricUnhealthyHostCount(props?: MetricOptions): Metric ``` The number of unhealthy hosts in the target group. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `registerConnectable` ```typescript public registerConnectable(connectable: IConnectable, portRange?: Port): void ``` Register a connectable as a member of this target group. Don't call this directly. It will be called by load balancing targets. ###### `connectable`^Required - *Type:* aws-cdk-lib.aws_ec2.IConnectable --- ###### `portRange`^Optional - *Type:* aws-cdk-lib.aws_ec2.Port --- ##### `registerListener` ```typescript public registerListener(listener: IApplicationListener, associatingConstruct?: IConstruct): void ``` Register a listener that is load balancing to this target group. Don't call this directly. It will be called by listeners. ###### `listener`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationListener --- ###### `associatingConstruct`^Optional - *Type:* constructs.IConstruct --- ##### `alarmHealthyHostCount` ```typescript public alarmHealthyHostCount(props?: ApplicationTargetGroupHealthyHostCountAlarmConfig): ApplicationTargetGroupHealthyHostCountAlarm ``` Creates an alarm that monitors the healthy host count for the ApplicationTargetGroup. ###### `props`^Optional - *Type:* ApplicationTargetGroupHealthyHostCountAlarmConfig --- ##### `alarmUnHealthyHostCount` ```typescript public alarmUnHealthyHostCount(props?: ApplicationTargetGroupUnHealthyHostCountAlarmConfig): ApplicationTargetGroupUnHealthyHostCountAlarm ``` Creates an alarm that monitors the unhealthy host count for the ApplicationTargetGroup. ###### `props`^Optional - *Type:* ApplicationTargetGroupUnHealthyHostCountAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: ApplicationTargetGroupRecommendedAlarmsConfig): ApplicationTargetGroupRecommendedAlarms ``` Creates the recommended alarms for the ApplicationTargetGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) ###### `props`^Required - *Type:* ApplicationTargetGroupRecommendedAlarmsConfig --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromTargetGroupAttributes | Import an existing target group. | --- ##### `isConstruct` ```typescript import { ApplicationTargetGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroup.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. --- ##### `fromTargetGroupAttributes` ```typescript import { ApplicationTargetGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroup.fromTargetGroupAttributes(scope: Construct, id: string, attrs: TargetGroupAttributes) ``` Import an existing target group. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.TargetGroupAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | firstLoadBalancerFullName | string | Full name of first load balancer. | | loadBalancerArns | string | A token representing a list of ARNs of the load balancers that route traffic to this target group. | | loadBalancerAttached | constructs.IDependable | List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer. | | targetGroupArn | string | The ARN of the target group. | | targetGroupFullName | string | The full name of the target group. | | targetGroupLoadBalancerArns | string[] | ARNs of load balancers load balancing to this TargetGroup. | | targetGroupName | string | The name of the target group. | | targetGroupRef | aws-cdk-lib.interfaces.aws_elasticloadbalancingv2.TargetGroupReference | A reference to this target group. | | healthCheck | aws-cdk-lib.aws_elasticloadbalancingv2.HealthCheck | Health check for the members of this target group. | | metrics | aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroupMetrics | All metrics available for this target group. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. --- ##### `firstLoadBalancerFullName`^Required ```typescript public readonly firstLoadBalancerFullName: string; ``` - *Type:* string Full name of first load balancer. --- ##### `loadBalancerArns`^Required ```typescript public readonly loadBalancerArns: string; ``` - *Type:* string A token representing a list of ARNs of the load balancers that route traffic to this target group. --- ##### `loadBalancerAttached`^Required ```typescript public readonly loadBalancerAttached: IDependable; ``` - *Type:* constructs.IDependable List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer. --- ##### `targetGroupArn`^Required ```typescript public readonly targetGroupArn: string; ``` - *Type:* string The ARN of the target group. --- ##### `targetGroupFullName`^Required ```typescript public readonly targetGroupFullName: string; ``` - *Type:* string The full name of the target group. --- ##### `targetGroupLoadBalancerArns`^Required ```typescript public readonly targetGroupLoadBalancerArns: string[]; ``` - *Type:* string[] ARNs of load balancers load balancing to this TargetGroup. --- ##### `targetGroupName`^Required ```typescript public readonly targetGroupName: string; ``` - *Type:* string The name of the target group. --- ##### `targetGroupRef`^Required ```typescript public readonly targetGroupRef: TargetGroupReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_elasticloadbalancingv2.TargetGroupReference A reference to this target group. --- ##### `healthCheck`^Required ```typescript public readonly healthCheck: HealthCheck; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.HealthCheck Health check for the members of this target group. --- ##### `metrics`^Required ```typescript public readonly metrics: IApplicationTargetGroupMetrics; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroupMetrics All metrics available for this target group. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApplicationTargetGroupHealthyHostCountAlarm This alarm is used to detect when the number of healthy hosts in the target group falls below the threshold. A low number of healthy hosts can indicate service availability issues. #### Initializers ```typescript import { ApplicationTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationTargetGroupHealthyHostCountAlarm(scope: IConstruct, id: string, props: ApplicationTargetGroupHealthyHostCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApplicationTargetGroupHealthyHostCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApplicationTargetGroupHealthyHostCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApplicationTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupHealthyHostCountAlarm.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 { ApplicationTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupHealthyHostCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApplicationTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupHealthyHostCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApplicationTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupHealthyHostCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApplicationTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupHealthyHostCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ApplicationTargetGroupRecommendedAlarms A construct that creates the recommended alarms for an ApplicationTargetGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) #### Initializers ```typescript import { ApplicationTargetGroupRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationTargetGroupRecommendedAlarms(scope: Construct, id: string, props: ApplicationTargetGroupRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ApplicationTargetGroupRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApplicationTargetGroupRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { ApplicationTargetGroupRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupRecommendedAlarms.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. | | alarmHealthyHostCount | ApplicationTargetGroupHealthyHostCountAlarm | The HealthyHostCount alarm. | | alarmUnHealthyHostCount | ApplicationTargetGroupUnHealthyHostCountAlarm | The UnHealthyHostCount alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmHealthyHostCount`^Optional ```typescript public readonly alarmHealthyHostCount: ApplicationTargetGroupHealthyHostCountAlarm; ``` - *Type:* ApplicationTargetGroupHealthyHostCountAlarm The HealthyHostCount alarm. --- ##### `alarmUnHealthyHostCount`^Optional ```typescript public readonly alarmUnHealthyHostCount: ApplicationTargetGroupUnHealthyHostCountAlarm; ``` - *Type:* ApplicationTargetGroupUnHealthyHostCountAlarm The UnHealthyHostCount alarm. --- ### ApplicationTargetGroupUnHealthyHostCountAlarm This alarm is used to detect when the number of unhealthy hosts in the target group exceeds the threshold. A high number of unhealthy hosts can indicate service health issues. #### Initializers ```typescript import { ApplicationTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationTargetGroupUnHealthyHostCountAlarm(scope: IConstruct, id: string, props: ApplicationTargetGroupUnHealthyHostCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ApplicationTargetGroupUnHealthyHostCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ApplicationTargetGroupUnHealthyHostCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ApplicationTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupUnHealthyHostCountAlarm.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 { ApplicationTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupUnHealthyHostCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ApplicationTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupUnHealthyHostCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ApplicationTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupUnHealthyHostCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ApplicationTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ApplicationTargetGroupUnHealthyHostCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### AutoScalingGroup An extension for the AutoScalingGroup construct that provides methods to create recommended alarms. #### Initializers ```typescript import { AutoScalingGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' new AutoScalingGroup(scope: Construct, id: string, props: AutoScalingGroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_autoscaling.AutoScalingGroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_autoscaling.AutoScalingGroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addLifecycleHook | Send a message to either an SQS queue or SNS topic when instances launch or terminate. | | addSecurityGroup | Add the security group to all instances via the launch template security groups array. | | addToRolePolicy | Adds a statement to the IAM role assumed by instances of this fleet. | | addUserData | Add command to the startup script of fleet instances. | | addWarmPool | Add a pool of pre-initialized EC2 instances that sits alongside an Auto Scaling group. | | applyCloudFormationInit | Use a CloudFormation Init configuration at instance startup. | | areNewInstancesProtectedFromScaleIn | Returns `true` if newly-launched instances are protected from scale-in. | | attachToApplicationTargetGroup | Attach to ELBv2 Application Target Group. | | attachToClassicLB | Attach to a classic load balancer. | | attachToNetworkTargetGroup | Attach to ELBv2 Application Target Group. | | protectNewInstancesFromScaleIn | Ensures newly-launched instances are protected from scale-in. | | scaleOnCpuUtilization | Scale out or in to achieve a target CPU utilization. | | scaleOnIncomingBytes | Scale out or in to achieve a target network ingress rate. | | scaleOnMetric | Scale out or in, in response to a metric. | | scaleOnOutgoingBytes | Scale out or in to achieve a target network egress rate. | | scaleOnRequestCount | Scale out or in to achieve a target request handling rate. | | scaleOnSchedule | Scale out or in based on time. | | scaleToTrackMetric | Scale out or in in order to keep a metric around a target value. | | alarmGroupInServiceCapacity | Creates an alarm that monitors the GroupInServiceCapacity for the EC2 autoScalingGroup. | | applyRecommendedAlarms | Creates the recommended alarms for the EC2 AutoScalingGroup. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addLifecycleHook` ```typescript public addLifecycleHook(id: string, props: BasicLifecycleHookProps): LifecycleHook ``` Send a message to either an SQS queue or SNS topic when instances launch or terminate. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_autoscaling.BasicLifecycleHookProps --- ##### `addSecurityGroup` ```typescript public addSecurityGroup(securityGroup: ISecurityGroup): void ``` Add the security group to all instances via the launch template security groups array. ###### `securityGroup`^Required - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup : The security group to add. --- ##### `addToRolePolicy` ```typescript public addToRolePolicy(statement: PolicyStatement): void ``` Adds a statement to the IAM role assumed by instances of this fleet. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement --- ##### `addUserData` ```typescript public addUserData(commands: ...string[]): void ``` Add command to the startup script of fleet instances. The command must be in the scripting language supported by the fleet's OS (i.e. Linux/Windows). Does nothing for imported ASGs. ###### `commands`^Required - *Type:* ...string[] --- ##### `addWarmPool` ```typescript public addWarmPool(options?: WarmPoolOptions): WarmPool ``` Add a pool of pre-initialized EC2 instances that sits alongside an Auto Scaling group. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_autoscaling.WarmPoolOptions --- ##### `applyCloudFormationInit` ```typescript public applyCloudFormationInit(init: CloudFormationInit, options?: ApplyCloudFormationInitOptions): void ``` Use a CloudFormation Init configuration at instance startup. This does the following: - Attaches the CloudFormation Init metadata to the AutoScalingGroup resource. - Add commands to the UserData to run `cfn-init` and `cfn-signal`. - Update the instance's CreationPolicy to wait for `cfn-init` to finish before reporting success. ###### `init`^Required - *Type:* aws-cdk-lib.aws_ec2.CloudFormationInit --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_autoscaling.ApplyCloudFormationInitOptions --- ##### `areNewInstancesProtectedFromScaleIn` ```typescript public areNewInstancesProtectedFromScaleIn(): boolean ``` Returns `true` if newly-launched instances are protected from scale-in. ##### `attachToApplicationTargetGroup` ```typescript public attachToApplicationTargetGroup(targetGroup: IApplicationTargetGroup): LoadBalancerTargetProps ``` Attach to ELBv2 Application Target Group. ###### `targetGroup`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup --- ##### `attachToClassicLB` ```typescript public attachToClassicLB(loadBalancer: LoadBalancer): void ``` Attach to a classic load balancer. ###### `loadBalancer`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancing.LoadBalancer --- ##### `attachToNetworkTargetGroup` ```typescript public attachToNetworkTargetGroup(targetGroup: INetworkTargetGroup): LoadBalancerTargetProps ``` Attach to ELBv2 Application Target Group. ###### `targetGroup`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup --- ##### `protectNewInstancesFromScaleIn` ```typescript public protectNewInstancesFromScaleIn(): void ``` Ensures newly-launched instances are protected from scale-in. ##### `scaleOnCpuUtilization` ```typescript public scaleOnCpuUtilization(id: string, props: CpuUtilizationScalingProps): TargetTrackingScalingPolicy ``` Scale out or in to achieve a target CPU utilization. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_autoscaling.CpuUtilizationScalingProps --- ##### `scaleOnIncomingBytes` ```typescript public scaleOnIncomingBytes(id: string, props: NetworkUtilizationScalingProps): TargetTrackingScalingPolicy ``` Scale out or in to achieve a target network ingress rate. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_autoscaling.NetworkUtilizationScalingProps --- ##### `scaleOnMetric` ```typescript public scaleOnMetric(id: string, props: BasicStepScalingPolicyProps): StepScalingPolicy ``` Scale out or in, in response to a metric. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_autoscaling.BasicStepScalingPolicyProps --- ##### `scaleOnOutgoingBytes` ```typescript public scaleOnOutgoingBytes(id: string, props: NetworkUtilizationScalingProps): TargetTrackingScalingPolicy ``` Scale out or in to achieve a target network egress rate. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_autoscaling.NetworkUtilizationScalingProps --- ##### `scaleOnRequestCount` ```typescript public scaleOnRequestCount(id: string, props: RequestCountScalingProps): TargetTrackingScalingPolicy ``` Scale out or in to achieve a target request handling rate. The AutoScalingGroup must have been attached to an Application Load Balancer in order to be able to call this. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_autoscaling.RequestCountScalingProps --- ##### `scaleOnSchedule` ```typescript public scaleOnSchedule(id: string, props: BasicScheduledActionProps): ScheduledAction ``` Scale out or in based on time. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_autoscaling.BasicScheduledActionProps --- ##### `scaleToTrackMetric` ```typescript public scaleToTrackMetric(id: string, props: MetricTargetTrackingProps): TargetTrackingScalingPolicy ``` Scale out or in in order to keep a metric around a target value. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_autoscaling.MetricTargetTrackingProps --- ##### `alarmGroupInServiceCapacity` ```typescript public alarmGroupInServiceCapacity(props: AutoScalingGroupInServiceCapacityAlarmConfig): AutoScalingGroupGroupInServiceCapacityAlarm ``` Creates an alarm that monitors the GroupInServiceCapacity for the EC2 autoScalingGroup. ###### `props`^Required - *Type:* AutoScalingGroupInServiceCapacityAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: AutoScalingGroupRecommendedAlarmsConfig): AutoScalingGroupRecommendedAlarms ``` Creates the recommended alarms for the EC2 AutoScalingGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#AutoScaling](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#AutoScaling) ###### `props`^Required - *Type:* AutoScalingGroupRecommendedAlarmsConfig --- #### 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. | | fromAutoScalingGroupName | *No description.* | --- ##### `isConstruct` ```typescript import { AutoScalingGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroup.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 { AutoScalingGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroup.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { AutoScalingGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroup.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAutoScalingGroupName` ```typescript import { AutoScalingGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroup.fromAutoScalingGroupName(scope: Construct, id: string, autoScalingGroupName: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `autoScalingGroupName`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | autoScalingGroupArn | string | Arn of the AutoScalingGroup. | | autoScalingGroupName | string | Name of the AutoScalingGroup. | | autoScalingGroupRef | aws-cdk-lib.interfaces.aws_autoscaling.AutoScalingGroupReference | A reference to a AutoScalingGroup resource. | | connections | aws-cdk-lib.aws_ec2.Connections | The network connections associated with this resource. | | grantPrincipal | aws-cdk-lib.aws_iam.IPrincipal | The principal to grant permissions to. | | osType | aws-cdk-lib.aws_ec2.OperatingSystemType | The type of OS instances of this fleet are running. | | role | aws-cdk-lib.aws_iam.IRole | The IAM Role in the instance profile. | | userData | aws-cdk-lib.aws_ec2.UserData | The Base64-encoded user data to make available to the launched EC2 instances. | | maxInstanceLifetime | aws-cdk-lib.Duration | The maximum amount of time that an instance can be in service. | | spotPrice | string | The maximum spot price configured for the autoscaling group. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `autoScalingGroupArn`^Required ```typescript public readonly autoScalingGroupArn: string; ``` - *Type:* string Arn of the AutoScalingGroup. --- ##### `autoScalingGroupName`^Required ```typescript public readonly autoScalingGroupName: string; ``` - *Type:* string Name of the AutoScalingGroup. --- ##### `autoScalingGroupRef`^Required ```typescript public readonly autoScalingGroupRef: AutoScalingGroupReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_autoscaling.AutoScalingGroupReference A reference to a AutoScalingGroup resource. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The network connections associated with this resource. --- ##### `grantPrincipal`^Required ```typescript public readonly grantPrincipal: IPrincipal; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal to grant permissions to. --- ##### `osType`^Required ```typescript public readonly osType: OperatingSystemType; ``` - *Type:* aws-cdk-lib.aws_ec2.OperatingSystemType The type of OS instances of this fleet are running. --- ##### `role`^Required ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole The IAM Role in the instance profile. --- ##### `userData`^Required ```typescript public readonly userData: UserData; ``` - *Type:* aws-cdk-lib.aws_ec2.UserData The Base64-encoded user data to make available to the launched EC2 instances. --- ##### `maxInstanceLifetime`^Optional ```typescript public readonly maxInstanceLifetime: Duration; ``` - *Type:* aws-cdk-lib.Duration The maximum amount of time that an instance can be in service. --- ##### `spotPrice`^Optional ```typescript public readonly spotPrice: string; ``` - *Type:* string The maximum spot price configured for the autoscaling group. `undefined` indicates that this group uses on-demand capacity. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### AutoScalingGroupGroupInServiceCapacityAlarm This alarm helps to detect when the capacity in the group is below the desired capacity required for your workload. To troubleshoot, check your scaling activities for launch failures and confirm that your desired capacity configuration is correct. The alarm is triggered when the capacity in the group is less than threshold. #### Initializers ```typescript import { AutoScalingGroupGroupInServiceCapacityAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new AutoScalingGroupGroupInServiceCapacityAlarm(scope: IConstruct, id: string, props: AutoScalingGroupGroupInServiceCapacityAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | AutoScalingGroupGroupInServiceCapacityAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* AutoScalingGroupGroupInServiceCapacityAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { AutoScalingGroupGroupInServiceCapacityAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroupGroupInServiceCapacityAlarm.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 { AutoScalingGroupGroupInServiceCapacityAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroupGroupInServiceCapacityAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { AutoScalingGroupGroupInServiceCapacityAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroupGroupInServiceCapacityAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { AutoScalingGroupGroupInServiceCapacityAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroupGroupInServiceCapacityAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { AutoScalingGroupGroupInServiceCapacityAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroupGroupInServiceCapacityAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### AutoScalingGroupRecommendedAlarms A construct that creates the recommended alarms for an EC2 AutoScalingGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#AutoScaling](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#AutoScaling) #### Initializers ```typescript import { AutoScalingGroupRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new AutoScalingGroupRecommendedAlarms(scope: Construct, id: string, props: AutoScalingGroupRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | AutoScalingGroupRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* AutoScalingGroupRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { AutoScalingGroupRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' AutoScalingGroupRecommendedAlarms.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. | | alarmGroupInServiceCapacity | AutoScalingGroupGroupInServiceCapacityAlarm | The GroupInServiceCapacity alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmGroupInServiceCapacity`^Optional ```typescript public readonly alarmGroupInServiceCapacity: AutoScalingGroupGroupInServiceCapacityAlarm; ``` - *Type:* AutoScalingGroupGroupInServiceCapacityAlarm The GroupInServiceCapacity alarm. --- ### Bucket An extension for the S3 Bucket construct that provides methods to create recommended alarms. #### Initializers ```typescript import { Bucket } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Bucket(scope: Construct, id: string, props?: BucketProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_s3.BucketProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* aws-cdk-lib.aws_s3.BucketProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addEventNotification | Adds a bucket notification event destination. | | addObjectCreatedNotification | Subscribes a destination to receive notifications when an object is created in the bucket. | | addObjectRemovedNotification | Subscribes a destination to receive notifications when an object is removed from the bucket. | | addReplicationPolicy | Function to add required permissions to the destination bucket for cross account replication. | | addToResourcePolicy | Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this bucket and/or its contents. Use `bucketArn` and `arnForObjects(keys)` to obtain ARNs for this bucket or objects. | | arnForObjects | Returns an ARN that represents all objects within the bucket that match the key pattern specified. | | enableEventBridgeNotification | Enables event bridge notification, causing all events below to be sent to EventBridge:. | | grantDelete | Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket. | | grantOnKey | Gives permissions to a grantable entity to perform actions on the encryption key. | | grantPublicAccess | Allows unrestricted access to objects from this bucket. | | grantPut | Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal. | | grantPutAcl | The use of this method is discouraged. Please use `grants.putAcl()` instead. | | grantRead | Grant read permissions for this bucket and its contents to an IAM principal (Role/Group/User). | | grantReadWrite | The use of this method is discouraged. Please use `grants.readWrite()` instead. | | grantReplicationPermission | Grant replication permission to a principal. This method allows the principal to perform replication operations on this bucket. | | grantWrite | The use of this method is discouraged. Please use `grants.write()` instead. | | onCloudTrailEvent | Define a CloudWatch event that triggers when something happens to this repository. | | onCloudTrailPutObject | Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call. | | onCloudTrailWriteObject | Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to. | | s3UrlForObject | The S3 URL of an S3 object. For example:. | | transferAccelerationUrlForObject | The https Transfer Acceleration URL of an S3 object. | | urlForObject | The https URL of an S3 object. Specify `regional: false` at the options for non-regional URLs. For example:. | | virtualHostedUrlForObject | The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:. | | addCorsRule | Adds a cross-origin access configuration for objects in an Amazon S3 bucket. | | addInventory | Add an inventory configuration. | | addLifecycleRule | Add a lifecycle rule to the bucket. | | addMetric | Adds a metrics configuration for the CloudWatch request metrics from the bucket. | | alarm4xxErrors | Creates an alarm that monitors the 4xx errors for the S3 bucket. | | alarm5xxErrors | Creates an alarm that monitors the 5xx errors for the S3 bucket. | | applyRecommendedAlarms | Creates the recommended alarms for the S3 bucket. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addEventNotification` ```typescript public addEventNotification(event: EventType, dest: IBucketNotificationDestination, filters: ...NotificationKeyFilter[]): void ``` Adds a bucket notification event destination. > [https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) *Example* ```typescript declare const myLambda: lambda.Function; const bucket = new s3.Bucket(this, 'MyBucket'); const filter: s3.NotificationKeyFilter = { prefix: 'home/myusername/*' }; bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.LambdaDestination(myLambda), filter); ``` ###### `event`^Required - *Type:* aws-cdk-lib.aws_s3.EventType The event to trigger the notification. --- ###### `dest`^Required - *Type:* aws-cdk-lib.aws_s3.IBucketNotificationDestination The notification destination (Lambda, SNS Topic or SQS Queue). --- ###### `filters`^Required - *Type:* ...aws-cdk-lib.aws_s3.NotificationKeyFilter[] S3 object key filter rules to determine which objects trigger this event. Each filter must include a `prefix` and/or `suffix` that will be matched against the s3 object key. Refer to the S3 Developer Guide for details about allowed filter rules. --- ##### `addObjectCreatedNotification` ```typescript public addObjectCreatedNotification(dest: IBucketNotificationDestination, filters: ...NotificationKeyFilter[]): void ``` Subscribes a destination to receive notifications when an object is created in the bucket. This is identical to calling `onEvent(EventType.OBJECT_CREATED)`. ###### `dest`^Required - *Type:* aws-cdk-lib.aws_s3.IBucketNotificationDestination The notification destination (see onEvent). --- ###### `filters`^Required - *Type:* ...aws-cdk-lib.aws_s3.NotificationKeyFilter[] Filters (see onEvent). --- ##### `addObjectRemovedNotification` ```typescript public addObjectRemovedNotification(dest: IBucketNotificationDestination, filters: ...NotificationKeyFilter[]): void ``` Subscribes a destination to receive notifications when an object is removed from the bucket. This is identical to calling `onEvent(EventType.OBJECT_REMOVED)`. ###### `dest`^Required - *Type:* aws-cdk-lib.aws_s3.IBucketNotificationDestination The notification destination (see onEvent). --- ###### `filters`^Required - *Type:* ...aws-cdk-lib.aws_s3.NotificationKeyFilter[] Filters (see onEvent). --- ##### `addReplicationPolicy` ```typescript public addReplicationPolicy(roleArn: string, accessControlTransition?: boolean, account?: string): void ``` Function to add required permissions to the destination bucket for cross account replication. These permissions will be added as a resource based policy on the bucket > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-accesscontroltranslation.html) ###### `roleArn`^Required - *Type:* string --- ###### `accessControlTransition`^Optional - *Type:* boolean --- ###### `account`^Optional - *Type:* string --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(permission: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the resource policy for a principal (i.e. account/role/service) to perform actions on this bucket and/or its contents. Use `bucketArn` and `arnForObjects(keys)` to obtain ARNs for this bucket or objects. Note that the policy statement may or may not be added to the policy. For example, when an `IBucket` is created from an existing bucket, it's not possible to tell whether the bucket already has a policy attached, let alone to re-use that policy to add more statements to it. So it's safest to do nothing in these cases. ###### `permission`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement the policy statement to be added to the bucket's policy. --- ##### `arnForObjects` ```typescript public arnForObjects(keyPattern: string): string ``` Returns an ARN that represents all objects within the bucket that match the key pattern specified. To represent all keys, specify ``"*"``. If you need to specify a keyPattern with multiple components, concatenate them into a single string, e.g.: arnForObjects(`home/${team}/${user}/*`) ###### `keyPattern`^Required - *Type:* string --- ##### `enableEventBridgeNotification` ```typescript public enableEventBridgeNotification(): void ``` Enables event bridge notification, causing all events below to be sent to EventBridge:. Object Deleted (DeleteObject) - Object Deleted (Lifecycle expiration) - Object Restore Initiated - Object Restore Completed - Object Restore Expired - Object Storage Class Changed - Object Access Tier Changed - Object ACL Updated - Object Tags Added - Object Tags Deleted ##### `grantDelete` ```typescript public grantDelete(identity: IGrantable, objectsKeyPattern?: any): Grant ``` Grants s3:DeleteObject* permission to an IAM principal for objects in this bucket. The use of this method is discouraged. Please use `grants.delete()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal. --- ###### `objectsKeyPattern`^Optional - *Type:* any Restrict the permission to a certain key pattern (default '*'). Parameter type is `any` but `string` should be passed in. --- ##### `grantOnKey` ```typescript public grantOnKey(grantee: IGrantable, actions: ...string[]): GrantOnKeyResult ``` Gives permissions to a grantable entity to perform actions on the encryption key. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `actions`^Required - *Type:* ...string[] --- ##### `grantPublicAccess` ```typescript public grantPublicAccess(allowedActions: ...string[], keyPrefix?: string): Grant ``` Allows unrestricted access to objects from this bucket. IMPORTANT: This permission allows anyone to perform actions on S3 objects in this bucket, which is useful for when you configure your bucket as a website and want everyone to be able to read objects in the bucket without needing to authenticate. Without arguments, this method will grant read ("s3:GetObject") access to all objects ("*") in the bucket. The method returns the `iam.Grant` object, which can then be modified as needed. For example, you can add a condition that will restrict access only to an IPv4 range like this: const grant = bucket.grantPublicAccess(); grant.resourceStatement!.addCondition(‘IpAddress’, { “aws:SourceIp”: “54.240.143.0/24” }); Note that if this `IBucket` refers to an existing bucket, possibly not managed by CloudFormation, this method will have no effect, since it's impossible to modify the policy of an existing bucket. The use of this method is discouraged. Please use `grants.publicAccess()` instead. [disable-awslint:no-grants] ###### `allowedActions`^Required - *Type:* ...string[] the set of S3 actions to allow. Default is "s3:GetObject". --- ###### `keyPrefix`^Optional - *Type:* string the prefix of S3 object keys (e.g. `home/*`). Default is "*". --- ##### `grantPut` ```typescript public grantPut(identity: IGrantable, objectsKeyPattern?: any): Grant ``` Grants s3:PutObject* and s3:Abort* permissions for this bucket to an IAM principal. If encryption is used, permission to use the key to encrypt the contents of written files will also be granted to the same principal. The use of this method is discouraged. Please use `grants.put()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal. --- ###### `objectsKeyPattern`^Optional - *Type:* any Restrict the permission to a certain key pattern (default '*'). Parameter type is `any` but `string` should be passed in. --- ##### `grantPutAcl` ```typescript public grantPutAcl(identity: IGrantable, objectsKeyPattern?: string): Grant ``` The use of this method is discouraged. Please use `grants.putAcl()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `objectsKeyPattern`^Optional - *Type:* string --- ##### `grantRead` ```typescript public grantRead(identity: IGrantable, objectsKeyPattern?: any): Grant ``` Grant read permissions for this bucket and its contents to an IAM principal (Role/Group/User). If encryption is used, permission to use the key to decrypt the contents of the bucket will also be granted to the same principal. The use of this method is discouraged. Please use `grants.read()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal. --- ###### `objectsKeyPattern`^Optional - *Type:* any Restrict the permission to a certain key pattern (default '*'). Parameter type is `any` but `string` should be passed in. --- ##### `grantReadWrite` ```typescript public grantReadWrite(identity: IGrantable, objectsKeyPattern?: any): Grant ``` The use of this method is discouraged. Please use `grants.readWrite()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `objectsKeyPattern`^Optional - *Type:* any --- ##### `grantReplicationPermission` ```typescript public grantReplicationPermission(identity: IGrantable, props: GrantReplicationPermissionProps): Grant ``` Grant replication permission to a principal. This method allows the principal to perform replication operations on this bucket. Note that when calling this function for source or destination buckets that support KMS encryption, you need to specify the KMS key for encryption and the KMS key for decryption, respectively. The use of this method is discouraged. Please use `grants.replicationPermission()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant replication permission to. --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_s3.GrantReplicationPermissionProps The properties of the replication source and destination buckets. --- ##### `grantWrite` ```typescript public grantWrite(identity: IGrantable, objectsKeyPattern?: any, allowedActionPatterns?: string[]): Grant ``` The use of this method is discouraged. Please use `grants.write()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `objectsKeyPattern`^Optional - *Type:* any --- ###### `allowedActionPatterns`^Optional - *Type:* string[] --- ##### `onCloudTrailEvent` ```typescript public onCloudTrailEvent(id: string, options?: OnCloudTrailBucketEventOptions): Rule ``` Define a CloudWatch event that triggers when something happens to this repository. Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail. ###### `id`^Required - *Type:* string The id of the rule. --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions Options for adding the rule. --- ##### `onCloudTrailPutObject` ```typescript public onCloudTrailPutObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule ``` Defines an AWS CloudWatch event that triggers when an object is uploaded to the specified paths (keys) in this bucket using the PutObject API call. Note that some tools like `aws s3 cp` will automatically use either PutObject or the multipart upload API depending on the file size, so using `onCloudTrailWriteObject` may be preferable. Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail. ###### `id`^Required - *Type:* string The id of the rule. --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions Options for adding the rule. --- ##### `onCloudTrailWriteObject` ```typescript public onCloudTrailWriteObject(id: string, options?: OnCloudTrailBucketEventOptions): Rule ``` Defines an AWS CloudWatch event that triggers when an object at the specified paths (keys) in this bucket are written to. This includes the events PutObject, CopyObject, and CompleteMultipartUpload. Note that some tools like `aws s3 cp` will automatically use either PutObject or the multipart upload API depending on the file size, so using this method may be preferable to `onCloudTrailPutObject`. Requires that there exists at least one CloudTrail Trail in your account that captures the event. This method will not create the Trail. ###### `id`^Required - *Type:* string The id of the rule. --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_s3.OnCloudTrailBucketEventOptions Options for adding the rule. --- ##### `s3UrlForObject` ```typescript public s3UrlForObject(key?: string): string ``` The S3 URL of an S3 object. For example:. `s3://onlybucket` - `s3://bucket/key` ###### `key`^Optional - *Type:* string The S3 key of the object. If not specified, the S3 URL of the bucket is returned. --- ##### `transferAccelerationUrlForObject` ```typescript public transferAccelerationUrlForObject(key?: string, options?: TransferAccelerationUrlOptions): string ``` The https Transfer Acceleration URL of an S3 object. Specify `dualStack: true` at the options for dual-stack endpoint (connect to the bucket over IPv6). For example: - `https://bucket.s3-accelerate.amazonaws.com` - `https://bucket.s3-accelerate.amazonaws.com/key` ###### `key`^Optional - *Type:* string The S3 key of the object. If not specified, the URL of the bucket is returned. --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_s3.TransferAccelerationUrlOptions Options for generating URL. --- ##### `urlForObject` ```typescript public urlForObject(key?: string): string ``` The https URL of an S3 object. Specify `regional: false` at the options for non-regional URLs. For example:. `https://s3.us-west-1.amazonaws.com/onlybucket` - `https://s3.us-west-1.amazonaws.com/bucket/key` - `https://s3.cn-north-1.amazonaws.com.cn/china-bucket/mykey` ###### `key`^Optional - *Type:* string The S3 key of the object. If not specified, the URL of the bucket is returned. --- ##### `virtualHostedUrlForObject` ```typescript public virtualHostedUrlForObject(key?: string, options?: VirtualHostedStyleUrlOptions): string ``` The virtual hosted-style URL of an S3 object. Specify `regional: false` at the options for non-regional URL. For example:. `https://only-bucket.s3.us-west-1.amazonaws.com` - `https://bucket.s3.us-west-1.amazonaws.com/key` - `https://bucket.s3.amazonaws.com/key` - `https://china-bucket.s3.cn-north-1.amazonaws.com.cn/mykey` ###### `key`^Optional - *Type:* string The S3 key of the object. If not specified, the URL of the bucket is returned. --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_s3.VirtualHostedStyleUrlOptions Options for generating URL. --- ##### `addCorsRule` ```typescript public addCorsRule(rule: CorsRule): void ``` Adds a cross-origin access configuration for objects in an Amazon S3 bucket. ###### `rule`^Required - *Type:* aws-cdk-lib.aws_s3.CorsRule The CORS configuration rule to add. --- ##### `addInventory` ```typescript public addInventory(inventory: Inventory): void ``` Add an inventory configuration. ###### `inventory`^Required - *Type:* aws-cdk-lib.aws_s3.Inventory configuration to add. --- ##### `addLifecycleRule` ```typescript public addLifecycleRule(rule: LifecycleRule): void ``` Add a lifecycle rule to the bucket. ###### `rule`^Required - *Type:* aws-cdk-lib.aws_s3.LifecycleRule The rule to add. --- ##### `addMetric` ```typescript public addMetric(metric: BucketMetrics): void ``` Adds a metrics configuration for the CloudWatch request metrics from the bucket. ###### `metric`^Required - *Type:* aws-cdk-lib.aws_s3.BucketMetrics The metric configuration to add. --- ##### `alarm4xxErrors` ```typescript public alarm4xxErrors(props?: S3Bucket4xxErrorsAlarmConfig): S3Bucket4xxErrorsAlarm ``` Creates an alarm that monitors the 4xx errors for the S3 bucket. ###### `props`^Optional - *Type:* S3Bucket4xxErrorsAlarmConfig --- ##### `alarm5xxErrors` ```typescript public alarm5xxErrors(props?: S3Bucket5xxErrorsAlarmConfig): S3Bucket5xxErrorsAlarm ``` Creates an alarm that monitors the 5xx errors for the S3 bucket. ###### `props`^Optional - *Type:* S3Bucket5xxErrorsAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props?: S3RecommendedAlarmsConfig): S3RecommendedAlarms ``` Creates the recommended alarms for the S3 bucket. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#S3](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#S3) ###### `props`^Optional - *Type:* S3RecommendedAlarmsConfig --- #### 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. | | fromBucketArn | *No description.* | | fromBucketAttributes | Creates a Bucket construct that represents an external bucket. | | fromBucketName | *No description.* | | fromCfnBucket | Create a mutable `IBucket` based on a low-level `CfnBucket`. | | validateBucketName | Thrown an exception if the given bucket name is not valid. | --- ##### `isConstruct` ```typescript import { Bucket } from '@renovosolutions/cdk-library-cloudwatch-alarms' Bucket.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 { Bucket } from '@renovosolutions/cdk-library-cloudwatch-alarms' Bucket.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Bucket } from '@renovosolutions/cdk-library-cloudwatch-alarms' Bucket.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromBucketArn` ```typescript import { Bucket } from '@renovosolutions/cdk-library-cloudwatch-alarms' Bucket.fromBucketArn(scope: Construct, id: string, bucketArn: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `bucketArn`^Required - *Type:* string --- ##### `fromBucketAttributes` ```typescript import { Bucket } from '@renovosolutions/cdk-library-cloudwatch-alarms' Bucket.fromBucketAttributes(scope: Construct, id: string, attrs: BucketAttributes) ``` Creates a Bucket construct that represents an external bucket. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_s3.BucketAttributes A `BucketAttributes` object. Can be obtained from a call to `bucket.export()` or manually created. --- ##### `fromBucketName` ```typescript import { Bucket } from '@renovosolutions/cdk-library-cloudwatch-alarms' Bucket.fromBucketName(scope: Construct, id: string, bucketName: string) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `bucketName`^Required - *Type:* string --- ##### `fromCfnBucket` ```typescript import { Bucket } from '@renovosolutions/cdk-library-cloudwatch-alarms' Bucket.fromCfnBucket(cfnBucket: CfnBucket) ``` Create a mutable `IBucket` based on a low-level `CfnBucket`. ###### `cfnBucket`^Required - *Type:* aws-cdk-lib.aws_s3.CfnBucket --- ##### `validateBucketName` ```typescript import { Bucket } from '@renovosolutions/cdk-library-cloudwatch-alarms' Bucket.validateBucketName(physicalName: string, allowLegacyBucketNaming?: boolean) ``` Thrown an exception if the given bucket name is not valid. ###### `physicalName`^Required - *Type:* string name of the bucket. --- ###### `allowLegacyBucketNaming`^Optional - *Type:* boolean allow legacy bucket naming style, default is false. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | bucketArn | string | The ARN of the bucket. | | bucketDomainName | string | The IPv4 DNS name of the specified bucket. | | bucketDualStackDomainName | string | The IPv6 DNS name of the specified bucket. | | bucketName | string | The name of the bucket. | | bucketRef | aws-cdk-lib.interfaces.aws_s3.BucketReference | A reference to a Bucket resource. | | bucketRegionalDomainName | string | The regional domain name of the specified bucket. | | bucketWebsiteDomainName | string | The Domain name of the static website. | | bucketWebsiteUrl | string | The URL of the static website. | | grants | aws-cdk-lib.aws_s3.BucketGrants | Collection of grant methods for a Bucket. | | encryptionKey | aws-cdk-lib.aws_kms.IKey | Optional KMS encryption key associated with this bucket. | | isWebsite | boolean | If this bucket has been configured for static website hosting. | | disallowPublicAccess | boolean | Whether to disallow public access. | | policy | aws-cdk-lib.aws_s3.BucketPolicy | The resource policy associated with this bucket. | | replicationRoleArn | string | Role used to set up permissions on this bucket for replication. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `bucketArn`^Required ```typescript public readonly bucketArn: string; ``` - *Type:* string The ARN of the bucket. --- ##### `bucketDomainName`^Required ```typescript public readonly bucketDomainName: string; ``` - *Type:* string The IPv4 DNS name of the specified bucket. --- ##### `bucketDualStackDomainName`^Required ```typescript public readonly bucketDualStackDomainName: string; ``` - *Type:* string The IPv6 DNS name of the specified bucket. --- ##### `bucketName`^Required ```typescript public readonly bucketName: string; ``` - *Type:* string The name of the bucket. --- ##### `bucketRef`^Required ```typescript public readonly bucketRef: BucketReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_s3.BucketReference A reference to a Bucket resource. --- ##### `bucketRegionalDomainName`^Required ```typescript public readonly bucketRegionalDomainName: string; ``` - *Type:* string The regional domain name of the specified bucket. --- ##### `bucketWebsiteDomainName`^Required ```typescript public readonly bucketWebsiteDomainName: string; ``` - *Type:* string The Domain name of the static website. --- ##### `bucketWebsiteUrl`^Required ```typescript public readonly bucketWebsiteUrl: string; ``` - *Type:* string The URL of the static website. --- ##### `grants`^Required ```typescript public readonly grants: BucketGrants; ``` - *Type:* aws-cdk-lib.aws_s3.BucketGrants Collection of grant methods for a Bucket. --- ##### `encryptionKey`^Optional ```typescript public readonly encryptionKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey Optional KMS encryption key associated with this bucket. --- ##### `isWebsite`^Optional ```typescript public readonly isWebsite: boolean; ``` - *Type:* boolean If this bucket has been configured for static website hosting. --- ##### `disallowPublicAccess`^Optional ```typescript public readonly disallowPublicAccess: boolean; ``` - *Type:* boolean Whether to disallow public access. --- ##### `policy`^Optional ```typescript public readonly policy: BucketPolicy; ``` - *Type:* aws-cdk-lib.aws_s3.BucketPolicy The resource policy associated with this bucket. If `autoCreatePolicy` is true, a `BucketPolicy` will be created upon the first call to addToResourcePolicy(s). --- ##### `replicationRoleArn`^Optional ```typescript public readonly replicationRoleArn: string; ``` - *Type:* string Role used to set up permissions on this bucket for replication. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### CfnCacheCluster An extension for the CfnCacheCluster construct that provides methods to create recommended alarms. #### Initializers ```typescript import { CfnCacheCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' new CfnCacheCluster(scope: Construct, id: string, props: CfnCacheClusterProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_elasticache.CfnCacheClusterProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_elasticache.CfnCacheClusterProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | | inspect | Examines the CloudFormation resource and discloses attributes. | | alarmDatabaseMemoryUsagePercentage | Creates an alarm that monitors the DatabaseMemoryUsagePercentage for the ElastiCache cacheCluster. | | alarmEngineCpuUtilization | Creates an alarm that monitors the EngineCpuUtilization for the ElastiCache cacheCluster. | | alarmReplicationLag | Creates an alarm that monitors the ReplicationLag for the ElastiCache cacheCluster. | | applyRecommendedAlarms | Creates the recommended alarms for the ElastiCache CfnCacheCluster. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. 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`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- ##### `inspect` ```typescript public inspect(inspector: TreeInspector): void ``` Examines the CloudFormation resource and discloses attributes. ###### `inspector`^Required - *Type:* aws-cdk-lib.TreeInspector tree inspector to collect and process attributes. --- ##### `alarmDatabaseMemoryUsagePercentage` ```typescript public alarmDatabaseMemoryUsagePercentage(props: ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig): ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm ``` Creates an alarm that monitors the DatabaseMemoryUsagePercentage for the ElastiCache cacheCluster. ###### `props`^Required - *Type:* ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig --- ##### `alarmEngineCpuUtilization` ```typescript public alarmEngineCpuUtilization(props?: ElastiCacheEngineCpuUtilizationAlarmConfig): ElastiCacheClusterEngineCpuUtilizationAlarm ``` Creates an alarm that monitors the EngineCpuUtilization for the ElastiCache cacheCluster. ###### `props`^Optional - *Type:* ElastiCacheEngineCpuUtilizationAlarmConfig --- ##### `alarmReplicationLag` ```typescript public alarmReplicationLag(props: ElastiCacheReplicationLagAlarmConfig): ElastiCacheClusterReplicationLagAlarm ``` Creates an alarm that monitors the ReplicationLag for the ElastiCache cacheCluster. ###### `props`^Required - *Type:* ElastiCacheReplicationLagAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: ElastiCacheClusterRecommendedAlarmsConfig): ElastiCacheClusterRecommendedAlarms ``` Creates the recommended alarms for the ElastiCache CfnCacheCluster. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache) ###### `props`^Required - *Type:* ElastiCacheClusterRecommendedAlarmsConfig --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | | isCfnCacheCluster | Checks whether the given object is a CfnCacheCluster. | --- ##### `isConstruct` ```typescript import { CfnCacheCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnCacheCluster.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. --- ##### `isCfnElement` ```typescript import { CfnCacheCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnCacheCluster.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnCacheCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnCacheCluster.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- ##### `isCfnCacheCluster` ```typescript import { CfnCacheCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnCacheCluster.isCfnCacheCluster(x: any) ``` Checks whether the given object is a CfnCacheCluster. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | *No description.* | | attrConfigurationEndpointAddress | string | The DNS hostname of the cache node. | | attrConfigurationEndpointPort | string | The port number of the configuration endpoint for the Memcached cache cluster. | | attrId | string | The resource name. | | attrRedisEndpointAddress | string | The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster. | | attrRedisEndpointPort | string | The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster. | | cacheClusterRef | aws-cdk-lib.interfaces.aws_elasticache.CacheClusterReference | A reference to a CacheCluster resource. | | tags | aws-cdk-lib.TagManager | Tag Manager which manages the tags for this resource. | | cacheNodeType | string | The compute and memory capacity of the nodes in the node group (shard). | | engine | string | The name of the cache engine to be used for this cluster. | | numCacheNodes | number | The number of cache nodes that the cache cluster should have. | | autoMinorVersionUpgrade | boolean \| aws-cdk-lib.IResolvable | If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions. | | azMode | string | Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. | | cacheParameterGroupName | string | The name of the parameter group to associate with this cluster. | | cacheSecurityGroupNames | string[] | A list of security group names to associate with this cluster. | | cacheSubnetGroupName | string | The name of the subnet group to be used for the cluster. | | clusterName | string | A name for the cache cluster. | | engineVersion | string | The version number of the cache engine to be used for this cluster. | | ipDiscovery | string | The network type you choose when modifying a cluster, either `ipv4` \| `ipv6` . | | logDeliveryConfigurations |

aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_elasticache.CfnCacheCluster.LogDeliveryConfigurationRequestProperty[]

| Specifies the destination, format and type of the logs. | | networkType | string | Must be either `ipv4` \| `ipv6` \| `dual_stack` . | | notificationTopicArn | string | The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. | | port | number | The port number on which each of the cache nodes accepts connections. | | preferredAvailabilityZone | string | The EC2 Availability Zone in which the cluster is created. | | preferredAvailabilityZones | string[] | A list of the Availability Zones in which cache nodes are created. | | preferredMaintenanceWindow | string | Specifies the weekly time range during which maintenance on the cluster is performed. | | snapshotArns | string[] | A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. | | snapshotName | string | The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). | | snapshotRetentionLimit | number | The number of days for which ElastiCache retains automatic snapshots before deleting them. | | snapshotWindow | string | The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). | | tagsRaw | aws-cdk-lib.CfnTag[] | A list of tags to be added to this resource. | | transitEncryptionEnabled | boolean \| aws-cdk-lib.IResolvable | A flag that enables in-transit encryption when set to true. | | vpcSecurityGroupIds | string[] | One or more VPC security groups associated with the cluster. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment --- ##### `attrConfigurationEndpointAddress`^Required ```typescript public readonly attrConfigurationEndpointAddress: string; ``` - *Type:* string The DNS hostname of the cache node. > Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt` returns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt` fails. --- ##### `attrConfigurationEndpointPort`^Required ```typescript public readonly attrConfigurationEndpointPort: string; ``` - *Type:* string The port number of the configuration endpoint for the Memcached cache cluster. > Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt` returns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt` fails. --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string The resource name. --- ##### `attrRedisEndpointAddress`^Required ```typescript public readonly attrRedisEndpointAddress: string; ``` - *Type:* string The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster. --- ##### `attrRedisEndpointPort`^Required ```typescript public readonly attrRedisEndpointPort: string; ``` - *Type:* string The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster. --- ##### `cacheClusterRef`^Required ```typescript public readonly cacheClusterRef: CacheClusterReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_elasticache.CacheClusterReference A reference to a CacheCluster resource. --- ##### `tags`^Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager Tag Manager which manages the tags for this resource. --- ##### `cacheNodeType`^Required ```typescript public readonly cacheNodeType: string; ``` - *Type:* string The compute and memory capacity of the nodes in the node group (shard). --- ##### `engine`^Required ```typescript public readonly engine: string; ``` - *Type:* string The name of the cache engine to be used for this cluster. --- ##### `numCacheNodes`^Required ```typescript public readonly numCacheNodes: number; ``` - *Type:* number The number of cache nodes that the cache cluster should have. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions. --- ##### `azMode`^Optional ```typescript public readonly azMode: string; ``` - *Type:* string Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. --- ##### `cacheParameterGroupName`^Optional ```typescript public readonly cacheParameterGroupName: string; ``` - *Type:* string The name of the parameter group to associate with this cluster. --- ##### `cacheSecurityGroupNames`^Optional ```typescript public readonly cacheSecurityGroupNames: string[]; ``` - *Type:* string[] A list of security group names to associate with this cluster. --- ##### `cacheSubnetGroupName`^Optional ```typescript public readonly cacheSubnetGroupName: string; ``` - *Type:* string The name of the subnet group to be used for the cluster. --- ##### `clusterName`^Optional ```typescript public readonly clusterName: string; ``` - *Type:* string A name for the cache cluster. --- ##### `engineVersion`^Optional ```typescript public readonly engineVersion: string; ``` - *Type:* string The version number of the cache engine to be used for this cluster. --- ##### `ipDiscovery`^Optional ```typescript public readonly ipDiscovery: string; ``` - *Type:* string The network type you choose when modifying a cluster, either `ipv4` | `ipv6` . --- ##### `logDeliveryConfigurations`^Optional ```typescript public readonly logDeliveryConfigurations: IResolvable | (IResolvable | LogDeliveryConfigurationRequestProperty)[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_elasticache.CfnCacheCluster.LogDeliveryConfigurationRequestProperty[] Specifies the destination, format and type of the logs. --- ##### `networkType`^Optional ```typescript public readonly networkType: string; ``` - *Type:* string Must be either `ipv4` | `ipv6` | `dual_stack` . --- ##### `notificationTopicArn`^Optional ```typescript public readonly notificationTopicArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number The port number on which each of the cache nodes accepts connections. --- ##### `preferredAvailabilityZone`^Optional ```typescript public readonly preferredAvailabilityZone: string; ``` - *Type:* string The EC2 Availability Zone in which the cluster is created. --- ##### `preferredAvailabilityZones`^Optional ```typescript public readonly preferredAvailabilityZones: string[]; ``` - *Type:* string[] A list of the Availability Zones in which cache nodes are created. --- ##### `preferredMaintenanceWindow`^Optional ```typescript public readonly preferredMaintenanceWindow: string; ``` - *Type:* string Specifies the weekly time range during which maintenance on the cluster is performed. --- ##### `snapshotArns`^Optional ```typescript public readonly snapshotArns: string[]; ``` - *Type:* string[] A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3. --- ##### `snapshotName`^Optional ```typescript public readonly snapshotName: string; ``` - *Type:* string The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard). --- ##### `snapshotRetentionLimit`^Optional ```typescript public readonly snapshotRetentionLimit: number; ``` - *Type:* number The number of days for which ElastiCache retains automatic snapshots before deleting them. --- ##### `snapshotWindow`^Optional ```typescript public readonly snapshotWindow: string; ``` - *Type:* string The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). --- ##### `tagsRaw`^Optional ```typescript public readonly tagsRaw: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] A list of tags to be added to this resource. --- ##### `transitEncryptionEnabled`^Optional ```typescript public readonly transitEncryptionEnabled: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable A flag that enables in-transit encryption when set to true. --- ##### `vpcSecurityGroupIds`^Optional ```typescript public readonly vpcSecurityGroupIds: string[]; ``` - *Type:* string[] One or more VPC security groups associated with the cluster. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CfnReplicationGroup An extension for the CfnReplicationGroup construct that provides methods to create recommended alarms. #### Initializers ```typescript import { CfnReplicationGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' new CfnReplicationGroup(scope: Construct, id: string, props: CfnReplicationGroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_elasticache.CfnReplicationGroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_elasticache.CfnReplicationGroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | | inspect | Examines the CloudFormation resource and discloses attributes. | | alarmDatabaseMemoryUsagePercentage | Creates an alarm that monitors the DatabaseMemoryUsagePercentage for the ElastiCache cacheReplicationGroup. | | alarmEngineCpuUtilization | Creates an alarm that monitors the EngineCpuUtilization for the ElastiCache cacheReplicationGroup. | | alarmReplicationLag | Creates an alarm that monitors the ReplicationLag for the ElastiCache cacheReplicationGroup. | | applyRecommendedAlarms | Creates the recommended alarms for the ElastiCache CfnReplicationGroup. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. 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`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- ##### `inspect` ```typescript public inspect(inspector: TreeInspector): void ``` Examines the CloudFormation resource and discloses attributes. ###### `inspector`^Required - *Type:* aws-cdk-lib.TreeInspector tree inspector to collect and process attributes. --- ##### `alarmDatabaseMemoryUsagePercentage` ```typescript public alarmDatabaseMemoryUsagePercentage(props: ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig): ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm ``` Creates an alarm that monitors the DatabaseMemoryUsagePercentage for the ElastiCache cacheReplicationGroup. ###### `props`^Required - *Type:* ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig --- ##### `alarmEngineCpuUtilization` ```typescript public alarmEngineCpuUtilization(props?: ElastiCacheEngineCpuUtilizationAlarmConfig): ElastiCacheReplicationGroupEngineCpuUtilizationAlarm ``` Creates an alarm that monitors the EngineCpuUtilization for the ElastiCache cacheReplicationGroup. ###### `props`^Optional - *Type:* ElastiCacheEngineCpuUtilizationAlarmConfig --- ##### `alarmReplicationLag` ```typescript public alarmReplicationLag(props: ElastiCacheReplicationLagAlarmConfig): ElastiCacheReplicationGroupReplicationLagAlarm ``` Creates an alarm that monitors the ReplicationLag for the ElastiCache cacheReplicationGroup. ###### `props`^Required - *Type:* ElastiCacheReplicationLagAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: ElastiCacheReplicationGroupRecommendedAlarmsConfig): ElastiCacheReplicationGroupRecommendedAlarms ``` Creates the recommended alarms for the ElastiCache CfnReplicationGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache) ###### `props`^Required - *Type:* ElastiCacheReplicationGroupRecommendedAlarmsConfig --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | | arnForReplicationGroup | *No description.* | | fromReplicationGroupId | Creates a new IReplicationGroupRef from a replicationGroupId. | | isCfnReplicationGroup | Checks whether the given object is a CfnReplicationGroup. | --- ##### `isConstruct` ```typescript import { CfnReplicationGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnReplicationGroup.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. --- ##### `isCfnElement` ```typescript import { CfnReplicationGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnReplicationGroup.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { CfnReplicationGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnReplicationGroup.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- ##### `arnForReplicationGroup` ```typescript import { CfnReplicationGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnReplicationGroup.arnForReplicationGroup(resource: IReplicationGroupRef) ``` ###### `resource`^Required - *Type:* aws-cdk-lib.interfaces.aws_elasticache.IReplicationGroupRef --- ##### `fromReplicationGroupId` ```typescript import { CfnReplicationGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnReplicationGroup.fromReplicationGroupId(scope: Construct, id: string, replicationGroupId: string) ``` Creates a new IReplicationGroupRef from a replicationGroupId. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `replicationGroupId`^Required - *Type:* string --- ##### `isCfnReplicationGroup` ```typescript import { CfnReplicationGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' CfnReplicationGroup.isCfnReplicationGroup(x: any) ``` Checks whether the given object is a CfnReplicationGroup. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | *No description.* | | attrConfigurationEndPoint | aws-cdk-lib.IResolvable | *No description.* | | attrConfigurationEndPointAddress | string | The DNS hostname of the cache node. | | attrConfigurationEndPointPort | string | The port number that the cache engine is listening on. | | attrPrimaryEndPoint | aws-cdk-lib.IResolvable | *No description.* | | attrPrimaryEndPointAddress | string | The DNS address of the primary read-write cache node. | | attrPrimaryEndPointPort | string | The number of the port that the primary read-write cache engine is listening on. | | attrReadEndPoint | aws-cdk-lib.IResolvable | *No description.* | | attrReadEndPointAddresses | string | A string with a list of endpoints for the primary and read-only replicas. | | attrReadEndPointAddressesList | string[] | A list of endpoints for the read-only replicas. | | attrReadEndPointPorts | string | A string with a list of ports for the read-only replicas. | | attrReadEndPointPortsList | string[] | A list of ports for the read-only replicas. | | attrReaderEndPoint | aws-cdk-lib.IResolvable | *No description.* | | attrReaderEndPointAddress | string | The address of the reader endpoint. | | attrReaderEndPointPort | string | The port used by the reader endpoint. | | replicationGroupRef | aws-cdk-lib.interfaces.aws_elasticache.ReplicationGroupReference | A reference to a ReplicationGroup resource. | | tags | aws-cdk-lib.TagManager | Tag Manager which manages the tags for this resource. | | replicationGroupDescription | string | A user-created description for the replication group. | | atRestEncryptionEnabled | boolean \| aws-cdk-lib.IResolvable | A flag that enables encryption at rest when set to `true` . | | authToken | string | *Reserved parameter.* The password used to access a password protected server. | | automaticFailoverEnabled | boolean \| aws-cdk-lib.IResolvable | Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. | | autoMinorVersionUpgrade | boolean \| aws-cdk-lib.IResolvable | If you are running Valkey 7.2 or later, or Redis OSS 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions. | | cacheNodeType | string | The compute and memory capacity of the nodes in the node group (shard). | | cacheParameterGroupName | string | The name of the parameter group to associate with this replication group. | | cacheSecurityGroupNames | string[] | A list of cache security group names to associate with this replication group. | | cacheSubnetGroupName | string | The name of the cache subnet group to be used for the replication group. | | clusterMode | string | The mode can be enabled or disabled. | | dataTieringEnabled | boolean \| aws-cdk-lib.IResolvable | Enables data tiering. | | engine | string | The name of the cache engine to be used for the clusters in this replication group. | | engineVersion | string | The version number of the cache engine to be used for the clusters in this replication group. | | globalReplicationGroupId | string | The name of the Global datastore. | | ipDiscovery | string | The network type you choose when creating a replication group, either `ipv4` \| `ipv6` . | | kmsKeyId | string | The ID of the KMS key used to encrypt the disk on the cluster. | | logDeliveryConfigurations |

aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_elasticache.CfnReplicationGroup.LogDeliveryConfigurationRequestProperty[]

aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_elasticache.CfnReplicationGroup.NodeGroupConfigurationProperty[]

| `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group. | | notificationTopicArn | string | The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. | | numCacheClusters | number | The number of clusters this replication group initially has. | | numNodeGroups | number | An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. | | port | number | The port number on which each member of the replication group accepts connections. | | preferredCacheClusterAZs | string[] | A list of EC2 Availability Zones in which the replication group's clusters are created. | | preferredMaintenanceWindow | string | Specifies the weekly time range during which maintenance on the cluster is performed. | | primaryClusterId | string | The identifier of the cluster that serves as the primary for this replication group. | | replicasPerNodeGroup | number | An optional parameter that specifies the number of replica nodes in each node group (shard). | | replicationGroupId | string | The replication group identifier. | | securityGroupIds | string[] | One or more Amazon VPC security groups associated with this replication group. | | snapshotArns | string[] | A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3. | | snapshotName | string | The name of a snapshot from which to restore data into the new replication group. | | snapshotRetentionLimit | number | The number of days for which ElastiCache retains automatic snapshots before deleting them. | | snapshottingClusterId | string | The cluster ID that is used as the daily snapshot source for the replication group. | | snapshotWindow | string | The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). | | tagsRaw | aws-cdk-lib.CfnTag[] | A list of tags to be added to this resource. | | transitEncryptionEnabled | boolean \| aws-cdk-lib.IResolvable | A flag that enables in-transit encryption when set to `true` . | | transitEncryptionMode | string | A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. | | userGroupIds | string[] | The ID of user group to associate with the replication group. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment --- ##### `attrConfigurationEndPoint`^Required ```typescript public readonly attrConfigurationEndPoint: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable --- ##### `attrConfigurationEndPointAddress`^Required ```typescript public readonly attrConfigurationEndPointAddress: string; ``` - *Type:* string The DNS hostname of the cache node. > Valkey or Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, `Fn::GetAtt` returns a value for this attribute only if the replication group is clustered. Otherwise, `Fn::GetAtt` fails. For Valkey or Redis OSS (cluster mode disabled) replication groups, use the `PrimaryEndpoint` or `ReadEndpoint` attributes. --- ##### `attrConfigurationEndPointPort`^Required ```typescript public readonly attrConfigurationEndPointPort: string; ``` - *Type:* string The port number that the cache engine is listening on. --- ##### `attrPrimaryEndPoint`^Required ```typescript public readonly attrPrimaryEndPoint: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable --- ##### `attrPrimaryEndPointAddress`^Required ```typescript public readonly attrPrimaryEndPointAddress: string; ``` - *Type:* string The DNS address of the primary read-write cache node. --- ##### `attrPrimaryEndPointPort`^Required ```typescript public readonly attrPrimaryEndPointPort: string; ``` - *Type:* string The number of the port that the primary read-write cache engine is listening on. --- ##### `attrReadEndPoint`^Required ```typescript public readonly attrReadEndPoint: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable --- ##### `attrReadEndPointAddresses`^Required ```typescript public readonly attrReadEndPointAddresses: string; ``` - *Type:* string A string with a list of endpoints for the primary and read-only replicas. The order of the addresses maps to the order of the ports from the `ReadEndPoint.Ports` attribute. --- ##### `attrReadEndPointAddressesList`^Required ```typescript public readonly attrReadEndPointAddressesList: string[]; ``` - *Type:* string[] A list of endpoints for the read-only replicas. The order of the addresses maps to the order of the ports from the ReadEndPoint.Ports attribute. --- ##### `attrReadEndPointPorts`^Required ```typescript public readonly attrReadEndPointPorts: string; ``` - *Type:* string A string with a list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the `ReadEndPoint.Addresses` attribute. --- ##### `attrReadEndPointPortsList`^Required ```typescript public readonly attrReadEndPointPortsList: string[]; ``` - *Type:* string[] A list of ports for the read-only replicas. The order of the ports maps to the order of the addresses from the ReadEndPoint.Addresses attribute. --- ##### `attrReaderEndPoint`^Required ```typescript public readonly attrReaderEndPoint: IResolvable; ``` - *Type:* aws-cdk-lib.IResolvable --- ##### `attrReaderEndPointAddress`^Required ```typescript public readonly attrReaderEndPointAddress: string; ``` - *Type:* string The address of the reader endpoint. --- ##### `attrReaderEndPointPort`^Required ```typescript public readonly attrReaderEndPointPort: string; ``` - *Type:* string The port used by the reader endpoint. --- ##### `replicationGroupRef`^Required ```typescript public readonly replicationGroupRef: ReplicationGroupReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_elasticache.ReplicationGroupReference A reference to a ReplicationGroup resource. --- ##### `tags`^Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager Tag Manager which manages the tags for this resource. --- ##### `replicationGroupDescription`^Required ```typescript public readonly replicationGroupDescription: string; ``` - *Type:* string A user-created description for the replication group. --- ##### `atRestEncryptionEnabled`^Optional ```typescript public readonly atRestEncryptionEnabled: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable A flag that enables encryption at rest when set to `true` . --- ##### `authToken`^Optional ```typescript public readonly authToken: string; ``` - *Type:* string *Reserved parameter.* The password used to access a password protected server. --- ##### `automaticFailoverEnabled`^Optional ```typescript public readonly automaticFailoverEnabled: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable If you are running Valkey 7.2 or later, or Redis OSS 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions. --- ##### `cacheNodeType`^Optional ```typescript public readonly cacheNodeType: string; ``` - *Type:* string The compute and memory capacity of the nodes in the node group (shard). --- ##### `cacheParameterGroupName`^Optional ```typescript public readonly cacheParameterGroupName: string; ``` - *Type:* string The name of the parameter group to associate with this replication group. --- ##### ~~`cacheSecurityGroupNames`~~^Optional - *Deprecated:* this property has been deprecated ```typescript public readonly cacheSecurityGroupNames: string[]; ``` - *Type:* string[] A list of cache security group names to associate with this replication group. --- ##### `cacheSubnetGroupName`^Optional ```typescript public readonly cacheSubnetGroupName: string; ``` - *Type:* string The name of the cache subnet group to be used for the replication group. --- ##### `clusterMode`^Optional ```typescript public readonly clusterMode: string; ``` - *Type:* string The mode can be enabled or disabled. --- ##### `dataTieringEnabled`^Optional ```typescript public readonly dataTieringEnabled: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable Enables data tiering. --- ##### `engine`^Optional ```typescript public readonly engine: string; ``` - *Type:* string The name of the cache engine to be used for the clusters in this replication group. --- ##### `engineVersion`^Optional ```typescript public readonly engineVersion: string; ``` - *Type:* string The version number of the cache engine to be used for the clusters in this replication group. --- ##### `globalReplicationGroupId`^Optional ```typescript public readonly globalReplicationGroupId: string; ``` - *Type:* string The name of the Global datastore. --- ##### `ipDiscovery`^Optional ```typescript public readonly ipDiscovery: string; ``` - *Type:* string The network type you choose when creating a replication group, either `ipv4` | `ipv6` . --- ##### `kmsKeyId`^Optional ```typescript public readonly kmsKeyId: string; ``` - *Type:* string The ID of the KMS key used to encrypt the disk on the cluster. --- ##### `logDeliveryConfigurations`^Optional ```typescript public readonly logDeliveryConfigurations: IResolvable | (IResolvable | LogDeliveryConfigurationRequestProperty)[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_elasticache.CfnReplicationGroup.LogDeliveryConfigurationRequestProperty[] Specifies the destination, format and type of the logs. --- ##### `multiAzEnabled`^Optional ```typescript public readonly multiAzEnabled: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. --- ##### `networkType`^Optional ```typescript public readonly networkType: string; ``` - *Type:* string Must be either `ipv4` | `ipv6` | `dual_stack` . --- ##### `nodeGroupConfiguration`^Optional ```typescript public readonly nodeGroupConfiguration: IResolvable | (IResolvable | NodeGroupConfigurationProperty)[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_elasticache.CfnReplicationGroup.NodeGroupConfigurationProperty[] `NodeGroupConfiguration` is a property of the `AWS::ElastiCache::ReplicationGroup` resource that configures an Amazon ElastiCache (ElastiCache) Valkey or Redis OSS cluster node group. --- ##### `notificationTopicArn`^Optional ```typescript public readonly notificationTopicArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. --- ##### `numCacheClusters`^Optional ```typescript public readonly numCacheClusters: number; ``` - *Type:* number The number of clusters this replication group initially has. --- ##### `numNodeGroups`^Optional ```typescript public readonly numNodeGroups: number; ``` - *Type:* number An optional parameter that specifies the number of node groups (shards) for this Valkey or Redis OSS (cluster mode enabled) replication group. --- ##### `port`^Optional ```typescript public readonly port: number; ``` - *Type:* number The port number on which each member of the replication group accepts connections. --- ##### `preferredCacheClusterAZs`^Optional ```typescript public readonly preferredCacheClusterAZs: string[]; ``` - *Type:* string[] A list of EC2 Availability Zones in which the replication group's clusters are created. --- ##### `preferredMaintenanceWindow`^Optional ```typescript public readonly preferredMaintenanceWindow: string; ``` - *Type:* string Specifies the weekly time range during which maintenance on the cluster is performed. --- ##### `primaryClusterId`^Optional ```typescript public readonly primaryClusterId: string; ``` - *Type:* string The identifier of the cluster that serves as the primary for this replication group. --- ##### `replicasPerNodeGroup`^Optional ```typescript public readonly replicasPerNodeGroup: number; ``` - *Type:* number An optional parameter that specifies the number of replica nodes in each node group (shard). --- ##### `replicationGroupId`^Optional ```typescript public readonly replicationGroupId: string; ``` - *Type:* string The replication group identifier. This parameter is stored as a lowercase string. --- ##### `securityGroupIds`^Optional ```typescript public readonly securityGroupIds: string[]; ``` - *Type:* string[] One or more Amazon VPC security groups associated with this replication group. --- ##### `snapshotArns`^Optional ```typescript public readonly snapshotArns: string[]; ``` - *Type:* string[] A list of Amazon Resource Names (ARN) that uniquely identify the Valkey or Redis OSS RDB snapshot files stored in Amazon S3. --- ##### `snapshotName`^Optional ```typescript public readonly snapshotName: string; ``` - *Type:* string The name of a snapshot from which to restore data into the new replication group. --- ##### `snapshotRetentionLimit`^Optional ```typescript public readonly snapshotRetentionLimit: number; ``` - *Type:* number The number of days for which ElastiCache retains automatic snapshots before deleting them. --- ##### `snapshottingClusterId`^Optional ```typescript public readonly snapshottingClusterId: string; ``` - *Type:* string The cluster ID that is used as the daily snapshot source for the replication group. --- ##### `snapshotWindow`^Optional ```typescript public readonly snapshotWindow: string; ``` - *Type:* string The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). --- ##### `tagsRaw`^Optional ```typescript public readonly tagsRaw: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] A list of tags to be added to this resource. --- ##### `transitEncryptionEnabled`^Optional ```typescript public readonly transitEncryptionEnabled: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable A flag that enables in-transit encryption when set to `true` . --- ##### `transitEncryptionMode`^Optional ```typescript public readonly transitEncryptionMode: string; ``` - *Type:* string A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. --- ##### `userGroupIds`^Optional ```typescript public readonly userGroupIds: string[]; ``` - *Type:* string[] The ID of user group to associate with the replication group. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### CloudFrontDistribution5xxErrorRateAlarm This alarm monitors the percentage of 5xx error responses from your origin server, to help you detect if the CloudFront service is having issues. See {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/troubleshooting-response-errors.html Troubleshooting error responses from your origin} for information to help you understand the problems with your server. The alarm is triggered when the percentage exceeds the threshold. #### Initializers ```typescript import { CloudFrontDistribution5xxErrorRateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new CloudFrontDistribution5xxErrorRateAlarm(scope: IConstruct, id: string, props: CloudFrontDistribution5xxErrorRateAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | CloudFrontDistribution5xxErrorRateAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* CloudFrontDistribution5xxErrorRateAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { CloudFrontDistribution5xxErrorRateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistribution5xxErrorRateAlarm.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 { CloudFrontDistribution5xxErrorRateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistribution5xxErrorRateAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { CloudFrontDistribution5xxErrorRateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistribution5xxErrorRateAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { CloudFrontDistribution5xxErrorRateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistribution5xxErrorRateAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { CloudFrontDistribution5xxErrorRateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistribution5xxErrorRateAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm This alarm helps you monitor execution errors from CloudFront functions so that you can take steps to resolve them. Analyze the CloudWatch function logs and look at the function code to find and resolve the root cause of the problem. The alarm is triggered when the number of execution errors is greater than threshold. #### Initializers ```typescript import { CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm(scope: IConstruct, id: string, props: CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm.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 { CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### CloudFrontDistributionDetailedFunctionThrottlesAlarm This alarm helps you to monitor if your CloudFront function is throttled. If your function is throttled, it means that it is taking too long to execute. To avoid function throttles, consider optimizing the function code. The alarm is triggered when the number of times the function was throttled is greater than threshold. #### Initializers ```typescript import { CloudFrontDistributionDetailedFunctionThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new CloudFrontDistributionDetailedFunctionThrottlesAlarm(scope: IConstruct, id: string, props: CloudFrontDistributionDetailedFunctionThrottlesAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | CloudFrontDistributionDetailedFunctionThrottlesAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* CloudFrontDistributionDetailedFunctionThrottlesAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { CloudFrontDistributionDetailedFunctionThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionThrottlesAlarm.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 { CloudFrontDistributionDetailedFunctionThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionThrottlesAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { CloudFrontDistributionDetailedFunctionThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionThrottlesAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { CloudFrontDistributionDetailedFunctionThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionThrottlesAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { CloudFrontDistributionDetailedFunctionThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionThrottlesAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### CloudFrontDistributionDetailedFunctionValidationErrorsAlarm This alarm helps you monitor validation errors from CloudFront functions so that you can take steps to resolve them. Analyze the CloudWatch function logs and look at the function code to find and resolve the root cause of the problem. The alarm is triggered when the number of validation errors is greater than threshold. #### Initializers ```typescript import { CloudFrontDistributionDetailedFunctionValidationErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new CloudFrontDistributionDetailedFunctionValidationErrorsAlarm(scope: IConstruct, id: string, props: CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { CloudFrontDistributionDetailedFunctionValidationErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionValidationErrorsAlarm.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 { CloudFrontDistributionDetailedFunctionValidationErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionValidationErrorsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { CloudFrontDistributionDetailedFunctionValidationErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionValidationErrorsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { CloudFrontDistributionDetailedFunctionValidationErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionValidationErrorsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { CloudFrontDistributionDetailedFunctionValidationErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionDetailedFunctionValidationErrorsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### CloudFrontDistributionOriginLatencyAlarm The alarm helps to monitor if the origin server is taking too long to respond. If the server takes too long to respond, it might lead to a timeout. Refer to {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/http-504-gateway-timeout.html#http-504-gateway-timeout-slow-application find and fix delayed responses from applications on your origin server} if you experience consistently high OriginLatency values. The alarm is triggered when the percentage is lower or equals the threshold. #### Initializers ```typescript import { CloudFrontDistributionOriginLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new CloudFrontDistributionOriginLatencyAlarm(scope: IConstruct, id: string, props: CloudFrontDistributionOriginLatencyAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | CloudFrontDistributionOriginLatencyAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* CloudFrontDistributionOriginLatencyAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { CloudFrontDistributionOriginLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionOriginLatencyAlarm.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 { CloudFrontDistributionOriginLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionOriginLatencyAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { CloudFrontDistributionOriginLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionOriginLatencyAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { CloudFrontDistributionOriginLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionOriginLatencyAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { CloudFrontDistributionOriginLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionOriginLatencyAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### CloudFrontDistributionRecommendedAlarms A construct that creates the recommended alarms for an CloudFront Distribution. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#CloudFront](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#CloudFront) #### Initializers ```typescript import { CloudFrontDistributionRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new CloudFrontDistributionRecommendedAlarms(scope: Construct, id: string, props: CloudFrontDistributionRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | CloudFrontDistributionRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* CloudFrontDistributionRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { CloudFrontDistributionRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' CloudFrontDistributionRecommendedAlarms.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. | | alarm5xxErrorRate | CloudFrontDistribution5xxErrorRateAlarm | The 5xxErrorRate alarm. | | alarmOriginLatency | CloudFrontDistributionOriginLatencyAlarm | The OriginLatency alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarm5xxErrorRate`^Optional ```typescript public readonly alarm5xxErrorRate: CloudFrontDistribution5xxErrorRateAlarm; ``` - *Type:* CloudFrontDistribution5xxErrorRateAlarm The 5xxErrorRate alarm. --- ##### `alarmOriginLatency`^Optional ```typescript public readonly alarmOriginLatency: CloudFrontDistributionOriginLatencyAlarm; ``` - *Type:* CloudFrontDistributionOriginLatencyAlarm The OriginLatency alarm. --- ### DatabaseCluster An extension of the database cluster construct that provides methods to create recommended alarms. #### Initializers ```typescript import { DatabaseCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DatabaseCluster(scope: Construct, id: string, props: DatabaseClusterProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_rds.DatabaseClusterProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_rds.DatabaseClusterProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addProxy | Add a new db proxy to this cluster. | | asSecretAttachmentTarget | Renders the secret attachment target specifications. | | grantConnect | [disable-awslint:no-grants]. | | grantDataApiAccess | Grant the given identity to access the Data API. | | metric | Return the given named metric for this DBCluster. | | metricCPUUtilization | The percentage of CPU utilization. | | metricDatabaseConnections | The number of database connections in use. | | metricDeadlocks | The average number of deadlocks in the database per second. | | metricEngineUptime | The amount of time that the instance has been running, in seconds. | | metricFreeableMemory | The amount of available random access memory, in bytes. | | metricFreeLocalStorage | The amount of local storage available, in bytes. | | metricNetworkReceiveThroughput | The amount of network throughput received from clients by each instance, in bytes per second. | | metricNetworkThroughput | The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second. | | metricNetworkTransmitThroughput | The amount of network throughput sent to clients by each instance, in bytes per second. | | metricSnapshotStorageUsed | The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window. | | metricTotalBackupStorageBilled | The total amount of backup storage in bytes for which you are billed. | | metricVolumeBytesUsed | The amount of storage used by your Aurora DB instance, in bytes. | | metricVolumeReadIOPs | The average number of disk read I/O operations per second. | | metricVolumeWriteIOPs | The average number of disk write I/O operations per second. | | addRotationMultiUser | Adds the multi user rotation to this cluster. | | addRotationSingleUser | Adds the single user rotation of the master password to this cluster. | | metricACUUtilization | This value is represented as a percentage. | | metricServerlessDatabaseCapacity | As a cluster-level metric, it represents the average of the ServerlessDatabaseCapacity values of all the Aurora Serverless v2 DB instances in the cluster. | | alarmAuroraBinLogReplicationLag | Creates an alarm that monitors the Bin Log Replication lag. | | alarmAuroraVolumeBytesLeftTotal | Creates an alarm that monitors the AuroraVolumeBytesLeftTotal. | | alarmAuroraVolumeBytesUsed | Creates an anomaly detection alarm on the VolumeBytesUsed metric. | | applyRecommendedAlarms | Creates recommended alarms for the database cluster. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addProxy` ```typescript public addProxy(id: string, options: DatabaseProxyOptions): DatabaseProxy ``` Add a new db proxy to this cluster. ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_rds.DatabaseProxyOptions --- ##### `asSecretAttachmentTarget` ```typescript public asSecretAttachmentTarget(): SecretAttachmentTargetProps ``` Renders the secret attachment target specifications. ##### `grantConnect` ```typescript public grantConnect(grantee: IGrantable, dbUser: string): Grant ``` [disable-awslint:no-grants]. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `dbUser`^Required - *Type:* string --- ##### `grantDataApiAccess` ```typescript public grantDataApiAccess(grantee: IGrantable): Grant ``` Grant the given identity to access the Data API. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this DBCluster. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCPUUtilization` ```typescript public metricCPUUtilization(props?: MetricOptions): Metric ``` The percentage of CPU utilization. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDatabaseConnections` ```typescript public metricDatabaseConnections(props?: MetricOptions): Metric ``` The number of database connections in use. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDeadlocks` ```typescript public metricDeadlocks(props?: MetricOptions): Metric ``` The average number of deadlocks in the database per second. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricEngineUptime` ```typescript public metricEngineUptime(props?: MetricOptions): Metric ``` The amount of time that the instance has been running, in seconds. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFreeableMemory` ```typescript public metricFreeableMemory(props?: MetricOptions): Metric ``` The amount of available random access memory, in bytes. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFreeLocalStorage` ```typescript public metricFreeLocalStorage(props?: MetricOptions): Metric ``` The amount of local storage available, in bytes. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkReceiveThroughput` ```typescript public metricNetworkReceiveThroughput(props?: MetricOptions): Metric ``` The amount of network throughput received from clients by each instance, in bytes per second. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkThroughput` ```typescript public metricNetworkThroughput(props?: MetricOptions): Metric ``` The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNetworkTransmitThroughput` ```typescript public metricNetworkTransmitThroughput(props?: MetricOptions): Metric ``` The amount of network throughput sent to clients by each instance, in bytes per second. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSnapshotStorageUsed` ```typescript public metricSnapshotStorageUsed(props?: MetricOptions): Metric ``` The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalBackupStorageBilled` ```typescript public metricTotalBackupStorageBilled(props?: MetricOptions): Metric ``` The total amount of backup storage in bytes for which you are billed. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeBytesUsed` ```typescript public metricVolumeBytesUsed(props?: MetricOptions): Metric ``` The amount of storage used by your Aurora DB instance, in bytes. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeReadIOPs` ```typescript public metricVolumeReadIOPs(props?: MetricOptions): Metric ``` The average number of disk read I/O operations per second. This metric is only available for Aurora database clusters. For non-Aurora RDS clusters, this metric will not return any data in CloudWatch. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricVolumeWriteIOPs` ```typescript public metricVolumeWriteIOPs(props?: MetricOptions): Metric ``` The average number of disk write I/O operations per second. This metric is only available for Aurora database clusters. For non-Aurora RDS clusters, this metric will not return any data in CloudWatch. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `addRotationMultiUser` ```typescript public addRotationMultiUser(id: string, options: RotationMultiUserOptions): SecretRotation ``` Adds the multi user rotation to this cluster. See [Alternating users rotation strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-two-users) ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_rds.RotationMultiUserOptions --- ##### `addRotationSingleUser` ```typescript public addRotationSingleUser(options?: RotationSingleUserOptions): SecretRotation ``` Adds the single user rotation of the master password to this cluster. See [Single user rotation strategy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets_strategies.html#rotating-secrets-one-user-one-password) ###### `options`^Optional - *Type:* aws-cdk-lib.aws_rds.RotationSingleUserOptions --- ##### `metricACUUtilization` ```typescript public metricACUUtilization(props?: MetricOptions): Metric ``` This value is represented as a percentage. It's calculated as the value of the ServerlessDatabaseCapacity metric divided by the maximum ACU value of the DB cluster. If this metric approaches a value of 100.0, the DB instance has scaled up as high as it can. Consider increasing the maximum ACU setting for the cluster. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricServerlessDatabaseCapacity` ```typescript public metricServerlessDatabaseCapacity(props?: MetricOptions): Metric ``` As a cluster-level metric, it represents the average of the ServerlessDatabaseCapacity values of all the Aurora Serverless v2 DB instances in the cluster. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `alarmAuroraBinLogReplicationLag` ```typescript public alarmAuroraBinLogReplicationLag(props?: RdsAuroraBinLogReplicationLagAlarmConfig): RdsAuroraBinLogReplicationLagAlarm ``` Creates an alarm that monitors the Bin Log Replication lag. ###### `props`^Optional - *Type:* RdsAuroraBinLogReplicationLagAlarmConfig --- ##### `alarmAuroraVolumeBytesLeftTotal` ```typescript public alarmAuroraVolumeBytesLeftTotal(props: RdsAuroraVolumeBytesLeftTotalAlarmConfig): RdsAuroraVolumeBytesLeftTotalAlarm ``` Creates an alarm that monitors the AuroraVolumeBytesLeftTotal. ###### `props`^Required - *Type:* RdsAuroraVolumeBytesLeftTotalAlarmConfig --- ##### `alarmAuroraVolumeBytesUsed` ```typescript public alarmAuroraVolumeBytesUsed(props?: RdsAuroraVolumeBytesUsedAlarmConfig): RdsAuroraVolumeBytesUsedAlarm ``` Creates an anomaly detection alarm on the VolumeBytesUsed metric. ###### `props`^Optional - *Type:* RdsAuroraVolumeBytesUsedAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: RdsAuroraRecommendedAlarmsConfig): RdsAuroraRecommendedAlarms ``` Creates recommended alarms for the database cluster. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS) ###### `props`^Required - *Type:* RdsAuroraRecommendedAlarmsConfig --- #### 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. | | fromDatabaseClusterAttributes | Import an existing DatabaseCluster from properties. | | fromLookup | Lookup an existing DatabaseCluster using clusterIdentifier. | --- ##### `isConstruct` ```typescript import { DatabaseCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseCluster.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 { DatabaseCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseCluster.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DatabaseCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseCluster.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromDatabaseClusterAttributes` ```typescript import { DatabaseCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseCluster.fromDatabaseClusterAttributes(scope: Construct, id: string, attrs: DatabaseClusterAttributes) ``` Import an existing DatabaseCluster from properties. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_rds.DatabaseClusterAttributes --- ##### `fromLookup` ```typescript import { DatabaseCluster } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseCluster.fromLookup(scope: Construct, id: string, options: DatabaseClusterLookupOptions) ``` Lookup an existing DatabaseCluster using clusterIdentifier. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_rds.DatabaseClusterLookupOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | clusterArn | string | The ARN of the cluster. | | clusterEndpoint | aws-cdk-lib.aws_rds.Endpoint | The endpoint to use for read/write operations. | | clusterIdentifier | string | Identifier of the cluster. | | clusterReadEndpoint | aws-cdk-lib.aws_rds.Endpoint | Endpoint to use for load-balanced read-only operations. | | clusterResourceIdentifier | string | The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP. | | connections | aws-cdk-lib.aws_ec2.Connections | Access to the network connections. | | dbClusterRef | aws-cdk-lib.interfaces.aws_rds.DBClusterReference | A reference to this database cluster. | | instanceEndpoints | aws-cdk-lib.aws_rds.Endpoint[] | Endpoints which address each individual replica. | | instanceIdentifiers | string[] | Identifiers of the replicas. | | engine | aws-cdk-lib.aws_rds.IClusterEngine | The engine for this Cluster. | | secret | aws-cdk-lib.aws_secretsmanager.ISecret | The secret attached to this cluster. | | cloudwatchLogGroups | {[ key: string ]: aws-cdk-lib.aws_logs.ILogGroup} | The log group is created when `cloudwatchLogsExports` is set. | | multiUserRotationApplication | aws-cdk-lib.aws_secretsmanager.SecretRotationApplication | Application for multi user rotation to this cluster. | | performanceInsightsEnabled | boolean | Whether Performance Insights is enabled at cluster level. | | singleUserRotationApplication | aws-cdk-lib.aws_secretsmanager.SecretRotationApplication | Application for single user rotation of the master password to this cluster. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC network to place the cluster in. | | databaseInsightsMode | aws-cdk-lib.aws_rds.DatabaseInsightsMode | The database insights mode. | | monitoringRole | aws-cdk-lib.aws_iam.IRole | The IAM role for the enhanced monitoring. | | performanceInsightEncryptionKey | aws-cdk-lib.aws_kms.IKey | The AWS KMS key for encryption of Performance Insights data. | | performanceInsightRetention | aws-cdk-lib.aws_rds.PerformanceInsightRetention | The amount of time, in days, to retain Performance Insights data. | | vpcSubnets | aws-cdk-lib.aws_ec2.SubnetSelection | The cluster's subnets. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `clusterArn`^Required ```typescript public readonly clusterArn: string; ``` - *Type:* string The ARN of the cluster. --- ##### `clusterEndpoint`^Required ```typescript public readonly clusterEndpoint: Endpoint; ``` - *Type:* aws-cdk-lib.aws_rds.Endpoint The endpoint to use for read/write operations. --- ##### `clusterIdentifier`^Required ```typescript public readonly clusterIdentifier: string; ``` - *Type:* string Identifier of the cluster. --- ##### `clusterReadEndpoint`^Required ```typescript public readonly clusterReadEndpoint: Endpoint; ``` - *Type:* aws-cdk-lib.aws_rds.Endpoint Endpoint to use for load-balanced read-only operations. --- ##### `clusterResourceIdentifier`^Required ```typescript public readonly clusterResourceIdentifier: string; ``` - *Type:* string The immutable identifier for the cluster; for example: cluster-ABCD1234EFGH5678IJKL90MNOP. This AWS Region-unique identifier is used in things like IAM authentication policies. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Access to the network connections. --- ##### `dbClusterRef`^Required ```typescript public readonly dbClusterRef: DBClusterReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_rds.DBClusterReference A reference to this database cluster. --- ##### `instanceEndpoints`^Required ```typescript public readonly instanceEndpoints: Endpoint[]; ``` - *Type:* aws-cdk-lib.aws_rds.Endpoint[] Endpoints which address each individual replica. --- ##### `instanceIdentifiers`^Required ```typescript public readonly instanceIdentifiers: string[]; ``` - *Type:* string[] Identifiers of the replicas. --- ##### `engine`^Optional ```typescript public readonly engine: IClusterEngine; ``` - *Type:* aws-cdk-lib.aws_rds.IClusterEngine The engine for this Cluster. Never undefined. --- ##### `secret`^Optional ```typescript public readonly secret: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret The secret attached to this cluster. --- ##### `cloudwatchLogGroups`^Required ```typescript public readonly cloudwatchLogGroups: {[ key: string ]: ILogGroup}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_logs.ILogGroup} The log group is created when `cloudwatchLogsExports` is set. Each export value will create a separate log group. --- ##### `multiUserRotationApplication`^Required ```typescript public readonly multiUserRotationApplication: SecretRotationApplication; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.SecretRotationApplication Application for multi user rotation to this cluster. --- ##### `performanceInsightsEnabled`^Required ```typescript public readonly performanceInsightsEnabled: boolean; ``` - *Type:* boolean Whether Performance Insights is enabled at cluster level. --- ##### `singleUserRotationApplication`^Required ```typescript public readonly singleUserRotationApplication: SecretRotationApplication; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.SecretRotationApplication Application for single user rotation of the master password to this cluster. --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC network to place the cluster in. --- ##### `databaseInsightsMode`^Optional ```typescript public readonly databaseInsightsMode: DatabaseInsightsMode; ``` - *Type:* aws-cdk-lib.aws_rds.DatabaseInsightsMode The database insights mode. --- ##### `monitoringRole`^Optional ```typescript public readonly monitoringRole: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole The IAM role for the enhanced monitoring. --- ##### `performanceInsightEncryptionKey`^Optional ```typescript public readonly performanceInsightEncryptionKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey The AWS KMS key for encryption of Performance Insights data. --- ##### `performanceInsightRetention`^Optional ```typescript public readonly performanceInsightRetention: PerformanceInsightRetention; ``` - *Type:* aws-cdk-lib.aws_rds.PerformanceInsightRetention The amount of time, in days, to retain Performance Insights data. --- ##### `vpcSubnets`^Optional ```typescript public readonly vpcSubnets: SubnetSelection; ``` - *Type:* aws-cdk-lib.aws_ec2.SubnetSelection The cluster's subnets. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DatabaseInstance An extension of the rds instance (database or cluster instance) construct that provides methods to create recommended alarms. #### Initializers ```typescript import { DatabaseInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DatabaseInstance(scope: Construct, id: string, props: DatabaseInstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_rds.DatabaseInstanceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_rds.DatabaseInstanceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addProxy | Add a new db proxy to this instance. | | asSecretAttachmentTarget | Renders the secret attachment target specifications. | | grantConnect | Grant the given identity connection access to the database. | | metric | Return the given named metric for this DBInstance. | | metricCPUUtilization | The percentage of CPU utilization. | | metricDatabaseConnections | The number of database connections in use. | | metricFreeableMemory | The amount of available random access memory. | | metricFreeStorageSpace | The amount of available storage space. | | metricReadIOPS | The average number of disk read I/O operations per second. The average number of disk write I/O operations per second. | | metricWriteIOPS | The average number of disk write I/O operations per second. The average number of disk read I/O operations per second. | | onEvent | Defines a CloudWatch event rule which triggers for instance events. | | addRotationMultiUser | Adds the multi user rotation to this instance. | | addRotationSingleUser | Adds the single user rotation of the master password to this instance. | | alarmCpuUtilization | Creates an alarm that monitors the CpuUtilization. | | alarmDatabaseConnections | Creates an alarm that monitors the DatabaseConnections. | | alarmDbLoad | Creates an alarm that monitors the DbLoad. | | alarmFreeableMemory | Creates an alarm that monitors the FreeableMemory. | | alarmFreeLocalStorage | Creates an alarm that monitors the FreeLocalStorage. | | alarmFreeStorageSpace | Creates an alarm that monitors the FreeStorageSpace. | | alarmReadLatency | Creates an alarm that monitors the ReadLatency. | | alarmWriteLatency | Creates an alarm that monitors the WriteLatency. | | applyRecommendedAlarms | Creates recommended alarms for the database instance. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addProxy` ```typescript public addProxy(id: string, options: DatabaseProxyOptions): DatabaseProxy ``` Add a new db proxy to this instance. ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_rds.DatabaseProxyOptions --- ##### `asSecretAttachmentTarget` ```typescript public asSecretAttachmentTarget(): SecretAttachmentTargetProps ``` Renders the secret attachment target specifications. ##### `grantConnect` ```typescript public grantConnect(grantee: IGrantable, dbUser?: string): Grant ``` Grant the given identity connection access to the database. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable the Principal to grant the permissions to. --- ###### `dbUser`^Optional - *Type:* string the name of the database user to allow connecting as to the db instance, or the default database user, obtained from the Secret, if not specified. --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this DBInstance. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCPUUtilization` ```typescript public metricCPUUtilization(props?: MetricOptions): Metric ``` The percentage of CPU utilization. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDatabaseConnections` ```typescript public metricDatabaseConnections(props?: MetricOptions): Metric ``` The number of database connections in use. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFreeableMemory` ```typescript public metricFreeableMemory(props?: MetricOptions): Metric ``` The amount of available random access memory. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFreeStorageSpace` ```typescript public metricFreeStorageSpace(props?: MetricOptions): Metric ``` The amount of available storage space. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricReadIOPS` ```typescript public metricReadIOPS(props?: MetricOptions): Metric ``` The average number of disk read I/O operations per second. The average number of disk write I/O operations per second. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricWriteIOPS` ```typescript public metricWriteIOPS(props?: MetricOptions): Metric ``` The average number of disk write I/O operations per second. The average number of disk read I/O operations per second. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `onEvent` ```typescript public onEvent(id: string, options?: OnEventOptions): Rule ``` Defines a CloudWatch event rule which triggers for instance events. Use `rule.addEventPattern(pattern)` to specify a filter. ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_events.OnEventOptions --- ##### `addRotationMultiUser` ```typescript public addRotationMultiUser(id: string, options: RotationMultiUserOptions): SecretRotation ``` Adds the multi user rotation to this instance. ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_rds.RotationMultiUserOptions --- ##### `addRotationSingleUser` ```typescript public addRotationSingleUser(options?: RotationSingleUserOptions): SecretRotation ``` Adds the single user rotation of the master password to this instance. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_rds.RotationSingleUserOptions the options for the rotation, if you want to override the defaults. --- ##### `alarmCpuUtilization` ```typescript public alarmCpuUtilization(props?: RdsCpuUtilizationAlarmConfig): RdsInstanceCpuUtilizationAlarm ``` Creates an alarm that monitors the CpuUtilization. ###### `props`^Optional - *Type:* RdsCpuUtilizationAlarmConfig --- ##### `alarmDatabaseConnections` ```typescript public alarmDatabaseConnections(props: RdsDatabaseConnectionsAlarmConfig): RdsInstanceDatabaseConnectionsAlarm ``` Creates an alarm that monitors the DatabaseConnections. ###### `props`^Required - *Type:* RdsDatabaseConnectionsAlarmConfig --- ##### `alarmDbLoad` ```typescript public alarmDbLoad(props: RdsDbLoadAlarmConfig): RdsInstanceDbLoadAlarm ``` Creates an alarm that monitors the DbLoad. ###### `props`^Required - *Type:* RdsDbLoadAlarmConfig --- ##### `alarmFreeableMemory` ```typescript public alarmFreeableMemory(props: RdsFreeableMemoryAlarmConfig): RdsInstanceFreeableMemoryAlarm ``` Creates an alarm that monitors the FreeableMemory. ###### `props`^Required - *Type:* RdsFreeableMemoryAlarmConfig --- ##### `alarmFreeLocalStorage` ```typescript public alarmFreeLocalStorage(props: RdsFreeLocalStorageAlarmConfig): RdsInstanceFreeLocalStorageAlarm ``` Creates an alarm that monitors the FreeLocalStorage. ###### `props`^Required - *Type:* RdsFreeLocalStorageAlarmConfig --- ##### `alarmFreeStorageSpace` ```typescript public alarmFreeStorageSpace(props: RdsFreeStorageSpaceAlarmConfig): RdsInstanceFreeStorageSpaceAlarm ``` Creates an alarm that monitors the FreeStorageSpace. ###### `props`^Required - *Type:* RdsFreeStorageSpaceAlarmConfig --- ##### `alarmReadLatency` ```typescript public alarmReadLatency(props: RdsReadLatencyAlarmConfig): RdsInstanceReadLatencyAlarm ``` Creates an alarm that monitors the ReadLatency. ###### `props`^Required - *Type:* RdsReadLatencyAlarmConfig --- ##### `alarmWriteLatency` ```typescript public alarmWriteLatency(props: RdsWriteLatencyAlarmConfig): RdsInstanceWriteLatencyAlarm ``` Creates an alarm that monitors the WriteLatency. ###### `props`^Required - *Type:* RdsWriteLatencyAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: RdsInstanceRecommendedAlarmsConfig): RdsInstanceRecommendedAlarms ``` Creates recommended alarms for the database instance. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS) ###### `props`^Required - *Type:* RdsInstanceRecommendedAlarmsConfig --- #### 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. | | fromDatabaseInstanceAttributes | Import an existing database instance. | | fromLookup | Lookup an existing DatabaseInstance using instanceIdentifier. | --- ##### `isConstruct` ```typescript import { DatabaseInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseInstance.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 { DatabaseInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseInstance.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DatabaseInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseInstance.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromDatabaseInstanceAttributes` ```typescript import { DatabaseInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseInstance.fromDatabaseInstanceAttributes(scope: Construct, id: string, attrs: DatabaseInstanceAttributes) ``` Import an existing database instance. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_rds.DatabaseInstanceAttributes --- ##### `fromLookup` ```typescript import { DatabaseInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' DatabaseInstance.fromLookup(scope: Construct, id: string, options: DatabaseInstanceLookupOptions) ``` Lookup an existing DatabaseInstance using instanceIdentifier. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_rds.DatabaseInstanceLookupOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | connections | aws-cdk-lib.aws_ec2.Connections | Access to network connections. | | dbInstanceEndpointAddress | string | The instance endpoint address. | | dbInstanceEndpointPort | string | The instance endpoint port. | | dbInstanceRef | aws-cdk-lib.interfaces.aws_rds.DBInstanceReference | A reference to this database instance. | | instanceArn | string | The instance arn. | | instanceEndpoint | aws-cdk-lib.aws_rds.Endpoint | The instance endpoint. | | instanceIdentifier | string | The instance identifier. | | engine | aws-cdk-lib.aws_rds.IInstanceEngine | The engine of this database Instance. | | instanceResourceId | string | The AWS Region-unique, immutable identifier for the DB instance. | | cloudwatchLogGroups | {[ key: string ]: aws-cdk-lib.aws_logs.ILogGroup} | The log group is created when `cloudwatchLogsExports` is set. | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC where this database instance is deployed. | | secret | aws-cdk-lib.aws_secretsmanager.ISecret | The AWS Secrets Manager secret attached to the instance. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Access to network connections. --- ##### `dbInstanceEndpointAddress`^Required ```typescript public readonly dbInstanceEndpointAddress: string; ``` - *Type:* string The instance endpoint address. --- ##### `dbInstanceEndpointPort`^Required ```typescript public readonly dbInstanceEndpointPort: string; ``` - *Type:* string The instance endpoint port. --- ##### `dbInstanceRef`^Required ```typescript public readonly dbInstanceRef: DBInstanceReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_rds.DBInstanceReference A reference to this database instance. --- ##### `instanceArn`^Required ```typescript public readonly instanceArn: string; ``` - *Type:* string The instance arn. --- ##### `instanceEndpoint`^Required ```typescript public readonly instanceEndpoint: Endpoint; ``` - *Type:* aws-cdk-lib.aws_rds.Endpoint The instance endpoint. --- ##### `instanceIdentifier`^Required ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The instance identifier. --- ##### `engine`^Optional ```typescript public readonly engine: IInstanceEngine; ``` - *Type:* aws-cdk-lib.aws_rds.IInstanceEngine The engine of this database Instance. May be not known for imported Instances if it wasn't provided explicitly, or for read replicas. --- ##### `instanceResourceId`^Optional ```typescript public readonly instanceResourceId: string; ``` - *Type:* string The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed. --- ##### `cloudwatchLogGroups`^Required ```typescript public readonly cloudwatchLogGroups: {[ key: string ]: ILogGroup}; ``` - *Type:* {[ key: string ]: aws-cdk-lib.aws_logs.ILogGroup} The log group is created when `cloudwatchLogsExports` is set. Each export value will create a separate log group. --- ##### `vpc`^Required ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC where this database instance is deployed. --- ##### `secret`^Optional ```typescript public readonly secret: ISecret; ``` - *Type:* aws-cdk-lib.aws_secretsmanager.ISecret The AWS Secrets Manager secret attached to the instance. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### Distribution An extension for the Distribution construct that provides methods to create recommended alarms. #### Initializers ```typescript import { Distribution } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Distribution(scope: Construct, id: string, props: DistributionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_cloudfront.DistributionProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_cloudfront.DistributionProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addBehavior | Adds a new behavior to this distribution for the given pathPattern. | | attachWebAclId | Attach WAF WebACL to this CloudFront distribution. | | grant | Adds an IAM policy statement associated with this distribution to an IAM principal's policy. | | grantCreateInvalidation | Grant to create invalidations for this bucket to an IAM principal (Role/Group/User). | | metric | Return the given named metric for this Distribution. | | metric401ErrorRate | Metric for the percentage of all viewer requests for which the response's HTTP status code is 401. | | metric403ErrorRate | Metric for the percentage of all viewer requests for which the response's HTTP status code is 403. | | metric404ErrorRate | Metric for the percentage of all viewer requests for which the response's HTTP status code is 404. | | metric4xxErrorRate | Metric for the percentage of all viewer requests for which the response's HTTP status code is 4xx. | | metric502ErrorRate | Metric for the percentage of all viewer requests for which the response's HTTP status code is 502. | | metric503ErrorRate | Metric for the percentage of all viewer requests for which the response's HTTP status code is 503. | | metric504ErrorRate | Metric for the percentage of all viewer requests for which the response's HTTP status code is 504. | | metric5xxErrorRate | Metric for the percentage of all viewer requests for which the response's HTTP status code is 5xx. | | metricBytesDownloaded | Metric for the total number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests. | | metricBytesUploaded | Metric for the total number of bytes that viewers uploaded to your origin with CloudFront, using POST and PUT requests. | | metricCacheHitRate | Metric for the percentage of all cacheable requests for which CloudFront served the content from its cache. | | metricOriginLatency | Metric for the total time spent from when CloudFront receives a request to when it starts providing a response to the network (not the viewer), for requests that are served from the origin, not the CloudFront cache. | | metricRequests | Metric for the total number of viewer requests received by CloudFront, for all HTTP methods and for both HTTP and HTTPS requests. | | metricTotalErrorRate | Metric for the percentage of all viewer requests for which the response's HTTP status code is 4xx or 5xx. | | alarm5xxErrorRate | Creates an alarm that monitors the 5xxErrorRate for the CloudFront distribution. | | alarmDetailedFunctionExecutionErrors | Creates a list of alarms that monitor the total number of execution errors produced by the function in a given time period. | | alarmDetailedFunctionThrottles | Creates a list of alarms that monitor the total number of times that the function was throttled in a given time period. | | alarmDetailedFunctionValidationErrors | Creates a list of alarms that monitor the total number of validation errors produced by the function in a given time period. | | alarmOriginLatency | Creates an alarm that monitors the OriginLatency for the CloudFront distribution. | | applyRecommendedAlarms | Creates the recommended alarms for the CloudFront Distribution. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addBehavior` ```typescript public addBehavior(pathPattern: string, origin: IOrigin, behaviorOptions?: AddBehaviorOptions): void ``` Adds a new behavior to this distribution for the given pathPattern. ###### `pathPattern`^Required - *Type:* string the path pattern (e.g., 'images/*') that specifies which requests to apply the behavior to. --- ###### `origin`^Required - *Type:* aws-cdk-lib.aws_cloudfront.IOrigin the origin to use for this behavior. --- ###### `behaviorOptions`^Optional - *Type:* aws-cdk-lib.aws_cloudfront.AddBehaviorOptions the options for the behavior at this path. --- ##### `attachWebAclId` ```typescript public attachWebAclId(webAclId: string): void ``` Attach WAF WebACL to this CloudFront distribution. WebACL must be in the us-east-1 region ###### `webAclId`^Required - *Type:* string The WAF WebACL to associate with this distribution. --- ##### `grant` ```typescript public grant(identity: IGrantable, actions: ...string[]): Grant ``` Adds an IAM policy statement associated with this distribution to an IAM principal's policy. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal. --- ###### `actions`^Required - *Type:* ...string[] The set of actions to allow (i.e. "cloudfront:ListInvalidations"). --- ##### `grantCreateInvalidation` ```typescript public grantCreateInvalidation(identity: IGrantable): Grant ``` Grant to create invalidations for this bucket to an IAM principal (Role/Group/User). [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal. --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Distribution. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metric401ErrorRate` ```typescript public metric401ErrorRate(props?: MetricOptions): Metric ``` Metric for the percentage of all viewer requests for which the response's HTTP status code is 401. To obtain this metric, you need to set `publishAdditionalMetrics` to `true`. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metric403ErrorRate` ```typescript public metric403ErrorRate(props?: MetricOptions): Metric ``` Metric for the percentage of all viewer requests for which the response's HTTP status code is 403. To obtain this metric, you need to set `publishAdditionalMetrics` to `true`. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metric404ErrorRate` ```typescript public metric404ErrorRate(props?: MetricOptions): Metric ``` Metric for the percentage of all viewer requests for which the response's HTTP status code is 404. To obtain this metric, you need to set `publishAdditionalMetrics` to `true`. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metric4xxErrorRate` ```typescript public metric4xxErrorRate(props?: MetricOptions): Metric ``` Metric for the percentage of all viewer requests for which the response's HTTP status code is 4xx. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metric502ErrorRate` ```typescript public metric502ErrorRate(props?: MetricOptions): Metric ``` Metric for the percentage of all viewer requests for which the response's HTTP status code is 502. To obtain this metric, you need to set `publishAdditionalMetrics` to `true`. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metric503ErrorRate` ```typescript public metric503ErrorRate(props?: MetricOptions): Metric ``` Metric for the percentage of all viewer requests for which the response's HTTP status code is 503. To obtain this metric, you need to set `publishAdditionalMetrics` to `true`. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metric504ErrorRate` ```typescript public metric504ErrorRate(props?: MetricOptions): Metric ``` Metric for the percentage of all viewer requests for which the response's HTTP status code is 504. To obtain this metric, you need to set `publishAdditionalMetrics` to `true`. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metric5xxErrorRate` ```typescript public metric5xxErrorRate(props?: MetricOptions): Metric ``` Metric for the percentage of all viewer requests for which the response's HTTP status code is 5xx. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricBytesDownloaded` ```typescript public metricBytesDownloaded(props?: MetricOptions): Metric ``` Metric for the total number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricBytesUploaded` ```typescript public metricBytesUploaded(props?: MetricOptions): Metric ``` Metric for the total number of bytes that viewers uploaded to your origin with CloudFront, using POST and PUT requests. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCacheHitRate` ```typescript public metricCacheHitRate(props?: MetricOptions): Metric ``` Metric for the percentage of all cacheable requests for which CloudFront served the content from its cache. HTTP POST and PUT requests, and errors, are not considered cacheable requests. To obtain this metric, you need to set `publishAdditionalMetrics` to `true`. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricOriginLatency` ```typescript public metricOriginLatency(props?: MetricOptions): Metric ``` Metric for the total time spent from when CloudFront receives a request to when it starts providing a response to the network (not the viewer), for requests that are served from the origin, not the CloudFront cache. This is also known as first byte latency, or time-to-first-byte. To obtain this metric, you need to set `publishAdditionalMetrics` to `true`. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricRequests` ```typescript public metricRequests(props?: MetricOptions): Metric ``` Metric for the total number of viewer requests received by CloudFront, for all HTTP methods and for both HTTP and HTTPS requests. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTotalErrorRate` ```typescript public metricTotalErrorRate(props?: MetricOptions): Metric ``` Metric for the percentage of all viewer requests for which the response's HTTP status code is 4xx or 5xx. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `alarm5xxErrorRate` ```typescript public alarm5xxErrorRate(props: CloudFront5xxErrorRateAlarmConfig): CloudFrontDistribution5xxErrorRateAlarm ``` Creates an alarm that monitors the 5xxErrorRate for the CloudFront distribution. ###### `props`^Required - *Type:* CloudFront5xxErrorRateAlarmConfig --- ##### `alarmDetailedFunctionExecutionErrors` ```typescript public alarmDetailedFunctionExecutionErrors(props: CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig[]): CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm[] ``` Creates a list of alarms that monitor the total number of execution errors produced by the function in a given time period. ###### `props`^Required - *Type:* CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig[] --- ##### `alarmDetailedFunctionThrottles` ```typescript public alarmDetailedFunctionThrottles(props: CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig[]): CloudFrontDistributionDetailedFunctionThrottlesAlarm[] ``` Creates a list of alarms that monitor the total number of times that the function was throttled in a given time period. ###### `props`^Required - *Type:* CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig[] --- ##### `alarmDetailedFunctionValidationErrors` ```typescript public alarmDetailedFunctionValidationErrors(props: CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig[]): CloudFrontDistributionDetailedFunctionValidationErrorsAlarm[] ``` Creates a list of alarms that monitor the total number of validation errors produced by the function in a given time period. ###### `props`^Required - *Type:* CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig[] --- ##### `alarmOriginLatency` ```typescript public alarmOriginLatency(props: CloudFrontOriginLatencyAlarmConfig): CloudFrontDistributionOriginLatencyAlarm ``` Creates an alarm that monitors the OriginLatency for the CloudFront distribution. ###### `props`^Required - *Type:* CloudFrontOriginLatencyAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: CloudFrontDistributionRecommendedAlarmsConfig): CloudFrontDistributionRecommendedAlarms ``` Creates the recommended alarms for the CloudFront Distribution. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#CloudFront](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#CloudFront) ###### `props`^Required - *Type:* CloudFrontDistributionRecommendedAlarmsConfig --- #### 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. | | fromDistributionAttributes | Creates a Distribution construct that represents an external (imported) distribution. | --- ##### `isConstruct` ```typescript import { Distribution } from '@renovosolutions/cdk-library-cloudwatch-alarms' Distribution.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 { Distribution } from '@renovosolutions/cdk-library-cloudwatch-alarms' Distribution.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Distribution } from '@renovosolutions/cdk-library-cloudwatch-alarms' Distribution.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromDistributionAttributes` ```typescript import { Distribution } from '@renovosolutions/cdk-library-cloudwatch-alarms' Distribution.fromDistributionAttributes(scope: Construct, id: string, attrs: DistributionAttributes) ``` Creates a Distribution construct that represents an external (imported) distribution. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_cloudfront.DistributionAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | distributionArn | string | The distribution ARN for this distribution. | | distributionDomainName | string | The domain name of the Distribution, such as d111111abcdef8.cloudfront.net. | | distributionId | string | The distribution ID for this distribution. | | distributionRef | aws-cdk-lib.interfaces.aws_cloudfront.DistributionReference | A reference to a Distribution resource. | | domainName | string | The domain name of the Distribution, such as d111111abcdef8.cloudfront.net. | | grants | aws-cdk-lib.aws_cloudfront.DistributionGrants | Collection of grant methods for a Distribution. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `distributionArn`^Required ```typescript public readonly distributionArn: string; ``` - *Type:* string The distribution ARN for this distribution. --- ##### `distributionDomainName`^Required ```typescript public readonly distributionDomainName: string; ``` - *Type:* string The domain name of the Distribution, such as d111111abcdef8.cloudfront.net. --- ##### `distributionId`^Required ```typescript public readonly distributionId: string; ``` - *Type:* string The distribution ID for this distribution. --- ##### `distributionRef`^Required ```typescript public readonly distributionRef: DistributionReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudfront.DistributionReference A reference to a Distribution resource. --- ##### `domainName`^Required ```typescript public readonly domainName: string; ``` - *Type:* string The domain name of the Distribution, such as d111111abcdef8.cloudfront.net. --- ##### `grants`^Required ```typescript public readonly grants: DistributionGrants; ``` - *Type:* aws-cdk-lib.aws_cloudfront.DistributionGrants Collection of grant methods for a Distribution. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DmsReplicationInstanceCpuUtilizationAlarm This alarm is used to detect high CPU utilization for the DMS Replication Instance. Consistent high CPU utilization can indicate a resource bottleneck or application performance problems. The alarm is triggered when CPU utilization exceeds % threshold. #### Initializers ```typescript import { DmsReplicationInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationInstanceCpuUtilizationAlarm(scope: IConstruct, id: string, props: DmsReplicationInstanceCpuUtilizationAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DmsReplicationInstanceCpuUtilizationAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DmsReplicationInstanceCpuUtilizationAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DmsReplicationInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceCpuUtilizationAlarm.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 { DmsReplicationInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceCpuUtilizationAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DmsReplicationInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceCpuUtilizationAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DmsReplicationInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceCpuUtilizationAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DmsReplicationInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceCpuUtilizationAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DmsReplicationInstanceFreeableMemoryAlarm An alarm that monitors the amount of available memory (RAM) on the replication instance. This alarm is used to help prevent running out of memory. The alarm is triggered when the percentage of available memory is less than threshold. #### Initializers ```typescript import { DmsReplicationInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationInstanceFreeableMemoryAlarm(scope: Construct, id: string, props: DmsReplicationInstanceFreeableMemoryAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DmsReplicationInstanceFreeableMemoryAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DmsReplicationInstanceFreeableMemoryAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DmsReplicationInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeableMemoryAlarm.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 { DmsReplicationInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeableMemoryAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DmsReplicationInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeableMemoryAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DmsReplicationInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeableMemoryAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DmsReplicationInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeableMemoryAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DmsReplicationInstanceFreeStorageSpaceAlarm An alarm that monitors the amount of available storage space for a DMS Replication Instance. This alarm helps prevent storage full issues. This can prevent downtime that occurs when your replication instance runs out of storage. The alarm is triggered when the amount of available storage space (bytes) is less than threshold. #### Initializers ```typescript import { DmsReplicationInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationInstanceFreeStorageSpaceAlarm(scope: IConstruct, id: string, props: DmsReplicationInstanceFreeStorageSpaceAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DmsReplicationInstanceFreeStorageSpaceAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DmsReplicationInstanceFreeStorageSpaceAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DmsReplicationInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeStorageSpaceAlarm.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 { DmsReplicationInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeStorageSpaceAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DmsReplicationInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeStorageSpaceAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DmsReplicationInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeStorageSpaceAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DmsReplicationInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceFreeStorageSpaceAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DmsReplicationInstanceRecommendedAlarms A construct that creates the recommended alarms for a DMS Replication Instance. #### Initializers ```typescript import { DmsReplicationInstanceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationInstanceRecommendedAlarms(scope: Construct, id: string, props: DmsReplicationInstanceRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DmsReplicationInstanceRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DmsReplicationInstanceRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { DmsReplicationInstanceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceRecommendedAlarms.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. | | alarmCpuUtilization | DmsReplicationInstanceCpuUtilizationAlarm | The CpuUtilization alarm. | | alarmFreeableMemory | DmsReplicationInstanceFreeableMemoryAlarm | The FreeableMemory alarm. | | alarmFreeStorageSpace | DmsReplicationInstanceFreeStorageSpaceAlarm | The FreeStorageSpace alarm. | | alarmSwapUsage | DmsReplicationInstanceSwapUsageAlarm | The SwapUsage alarm. | | alarmWriteIops | DmsReplicationInstanceWriteIopsAlarm | The WriteIops alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmCpuUtilization`^Optional ```typescript public readonly alarmCpuUtilization: DmsReplicationInstanceCpuUtilizationAlarm; ``` - *Type:* DmsReplicationInstanceCpuUtilizationAlarm The CpuUtilization alarm. --- ##### `alarmFreeableMemory`^Optional ```typescript public readonly alarmFreeableMemory: DmsReplicationInstanceFreeableMemoryAlarm; ``` - *Type:* DmsReplicationInstanceFreeableMemoryAlarm The FreeableMemory alarm. --- ##### `alarmFreeStorageSpace`^Optional ```typescript public readonly alarmFreeStorageSpace: DmsReplicationInstanceFreeStorageSpaceAlarm; ``` - *Type:* DmsReplicationInstanceFreeStorageSpaceAlarm The FreeStorageSpace alarm. --- ##### `alarmSwapUsage`^Optional ```typescript public readonly alarmSwapUsage: DmsReplicationInstanceSwapUsageAlarm; ``` - *Type:* DmsReplicationInstanceSwapUsageAlarm The SwapUsage alarm. --- ##### `alarmWriteIops`^Optional ```typescript public readonly alarmWriteIops: DmsReplicationInstanceWriteIopsAlarm; ``` - *Type:* DmsReplicationInstanceWriteIopsAlarm The WriteIops alarm. --- ### DmsReplicationInstanceSwapUsageAlarm This anomaly detection alarm is used to detect high swap usage for the DMS Replication Instance. High swap usage can indicate memory pressure, performance issues, or resource constraints. This alarm uses anomaly detection to identify when swap usage exceeds normal patterns, which can help identify performance degradation or insufficient memory allocation. By default, the alarm is triggered when swap usage exceeds the upper threshold of the anomaly detection band, detecting unusually high swap usage that may indicate memory pressure or performance issues. Note: Anomaly detection alarms use a fixed 5-minute period as required by AWS CloudWatch. This period cannot be customized and is optimal for anomaly detection algorithms. #### Initializers ```typescript import { DmsReplicationInstanceSwapUsageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationInstanceSwapUsageAlarm(scope: IConstruct, id: string, props: DmsReplicationInstanceSwapUsageAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DmsReplicationInstanceSwapUsageAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DmsReplicationInstanceSwapUsageAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DmsReplicationInstanceSwapUsageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceSwapUsageAlarm.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 { DmsReplicationInstanceSwapUsageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceSwapUsageAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DmsReplicationInstanceSwapUsageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceSwapUsageAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DmsReplicationInstanceSwapUsageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceSwapUsageAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DmsReplicationInstanceSwapUsageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceSwapUsageAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DmsReplicationInstanceWriteIopsAlarm This alarm is used to detect high write IOPS for the DMS Replication Instance. High write IOPS can indicate heavy write activity or potential I/O bottlenecks. This can help identify performance issues or unexpected workload patterns. The alarm is triggered when write IOPS exceeds the specified threshold. #### Initializers ```typescript import { DmsReplicationInstanceWriteIopsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationInstanceWriteIopsAlarm(scope: IConstruct, id: string, props: DmsReplicationInstanceWriteIopsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DmsReplicationInstanceWriteIopsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DmsReplicationInstanceWriteIopsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DmsReplicationInstanceWriteIopsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceWriteIopsAlarm.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 { DmsReplicationInstanceWriteIopsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceWriteIopsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DmsReplicationInstanceWriteIopsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceWriteIopsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DmsReplicationInstanceWriteIopsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceWriteIopsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DmsReplicationInstanceWriteIopsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationInstanceWriteIopsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DmsReplicationTaskCdcLatencySourceAlarm An alarm that monitors the CDC latency (in seconds) from the source database. This alarm monitors the gap between the last event captured from the source endpoint and current system time. It can help detect: - Replication lag indicating source database performance issues - Network connectivity problems affecting CDC capture - Source database load affecting change capture performance - Data freshness issues that could impact real-time applications The alarm is typically configured to trigger on high latency values. #### Initializers ```typescript import { DmsReplicationTaskCdcLatencySourceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationTaskCdcLatencySourceAlarm(scope: IConstruct, id: string, props: DmsReplicationTaskCdcLatencySourceAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DmsReplicationTaskCdcLatencySourceAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DmsReplicationTaskCdcLatencySourceAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DmsReplicationTaskCdcLatencySourceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencySourceAlarm.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 { DmsReplicationTaskCdcLatencySourceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencySourceAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DmsReplicationTaskCdcLatencySourceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencySourceAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DmsReplicationTaskCdcLatencySourceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencySourceAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DmsReplicationTaskCdcLatencySourceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencySourceAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DmsReplicationTaskCdcLatencyTargetAlarm An alarm that monitors the CDC latency (in seconds) to the target database. This alarm monitors the gap between a change that was committed to the source and the same change committed to the target. It can help detect: - End-to-end replication latency affecting data consistency - Target database performance issues affecting write operations - Network connectivity problems between replication instance and target - Data consistency issues that could impact downstream applications The alarm is typically configured to trigger on high latency values. #### Initializers ```typescript import { DmsReplicationTaskCdcLatencyTargetAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationTaskCdcLatencyTargetAlarm(scope: IConstruct, id: string, props: DmsReplicationTaskCdcLatencyTargetAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DmsReplicationTaskCdcLatencyTargetAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DmsReplicationTaskCdcLatencyTargetAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DmsReplicationTaskCdcLatencyTargetAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencyTargetAlarm.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 { DmsReplicationTaskCdcLatencyTargetAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencyTargetAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DmsReplicationTaskCdcLatencyTargetAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencyTargetAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DmsReplicationTaskCdcLatencyTargetAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencyTargetAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DmsReplicationTaskCdcLatencyTargetAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskCdcLatencyTargetAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DmsReplicationTaskRecommendedAlarms A construct that creates the recommended alarms for a DMS Replication Task. #### Initializers ```typescript import { DmsReplicationTaskRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationTaskRecommendedAlarms(scope: Construct, id: string, props: DmsReplicationTaskRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DmsReplicationTaskRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DmsReplicationTaskRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { DmsReplicationTaskRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' DmsReplicationTaskRecommendedAlarms.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. | | alarmCdcLatencySource | DmsReplicationTaskCdcLatencySourceAlarm | The CDCLatencySource alarm. | | alarmCdcLatencyTarget | DmsReplicationTaskCdcLatencyTargetAlarm | The CDCLatencyTarget alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmCdcLatencySource`^Optional ```typescript public readonly alarmCdcLatencySource: DmsReplicationTaskCdcLatencySourceAlarm; ``` - *Type:* DmsReplicationTaskCdcLatencySourceAlarm The CDCLatencySource alarm. --- ##### `alarmCdcLatencyTarget`^Optional ```typescript public readonly alarmCdcLatencyTarget: DmsReplicationTaskCdcLatencyTargetAlarm; ``` - *Type:* DmsReplicationTaskCdcLatencyTargetAlarm The CDCLatencyTarget alarm. --- ### DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm This alarm detects the delay in replication to a Kinesis data stream. Under normal operation, `AgeOfOldestUnreplicatedRecord` should be only milliseconds. This number grows based on unsuccessful replication attempts caused by customer-controlled configuration choices. Customer-controlled configuration examples that lead to unsuccessful replication attempts are an under-provisioned Kinesis data stream capacity that leads to excessive throttling. or a manual update to the Kinesis data stream's access policies that prevents DynamoDB from adding data to the data stream. To keep this metric as low as possible, you need to ensure the right provisioning of Kinesis data stream capacity and make sure that DynamoDB's permissions are unchanged. The alarm is triggered when the elapsed time since a record yet to be replicated exceeds the threshold. #### Initializers ```typescript import { DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm(scope: IConstruct, id: string, props: DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm.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 { DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DynamoDbTableFailedToReplicateRecordCountAlarm This alarm detects the number of records that DynamoDB failed to replicate to your Kinesis data stream. Certain items larger than 34 KB might expand in size to change data records that are larger than the 1 MB item size limit of Kinesis Data Streams. This size expansion occurs when these larger than 34 KB items include a large number of Boolean or empty attribute values. Boolean and empty attribute values are stored as 1 byte in DynamoDB, but expand up to 5 bytes when they're serialized using standard JSON for Kinesis Data Streams replication. DynamoDB can't replicate such change records to your Kinesis data stream. DynamoDB skips these change data records, and automatically continues replicating subsequent records. The alarm is triggered when the the number of records failed to be replicated exceeds the threshold. #### Initializers ```typescript import { DynamoDbTableFailedToReplicateRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DynamoDbTableFailedToReplicateRecordCountAlarm(scope: IConstruct, id: string, props: DynamoDbTableFailedToReplicateRecordCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DynamoDbTableFailedToReplicateRecordCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DynamoDbTableFailedToReplicateRecordCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DynamoDbTableFailedToReplicateRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableFailedToReplicateRecordCountAlarm.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 { DynamoDbTableFailedToReplicateRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableFailedToReplicateRecordCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DynamoDbTableFailedToReplicateRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableFailedToReplicateRecordCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DynamoDbTableFailedToReplicateRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableFailedToReplicateRecordCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DynamoDbTableFailedToReplicateRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableFailedToReplicateRecordCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DynamoDbTableReadThrottleEventsAlarm This alarm detects if there are high number of read requests getting throttled for the DynamoDB table. To troubleshoot the issue, see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TroubleshootingThrottling.html Troubleshooting throttling issues in Amazon DynamoDB}. The alarm is triggered when the number of read requests exceeds the threshold. #### Initializers ```typescript import { DynamoDbTableReadThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DynamoDbTableReadThrottleEventsAlarm(scope: IConstruct, id: string, props: DynamoDbTableReadThrottleEventsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DynamoDbTableReadThrottleEventsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DynamoDbTableReadThrottleEventsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DynamoDbTableReadThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableReadThrottleEventsAlarm.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 { DynamoDbTableReadThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableReadThrottleEventsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DynamoDbTableReadThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableReadThrottleEventsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DynamoDbTableReadThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableReadThrottleEventsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DynamoDbTableReadThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableReadThrottleEventsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DynamoDbTableRecommendedAlarms A construct that creates the recommended alarms for an DynamoDb Table. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#DynamoDB](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#DynamoDB) #### Initializers ```typescript import { DynamoDbTableRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DynamoDbTableRecommendedAlarms(scope: Construct, id: string, props: DynamoDbTableRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | DynamoDbTableRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DynamoDbTableRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { DynamoDbTableRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableRecommendedAlarms.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. | | alarmAgeOfOldestUnreplicatedRecord | DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm | The AgeOfOldestUnreplicatedRecord alarm. | | alarmFailedToReplicateRecordCount | DynamoDbTableFailedToReplicateRecordCountAlarm | The FailedToReplicateRecordCount alarm. | | alarmReadThrottleEvents | DynamoDbTableReadThrottleEventsAlarm | The ReadThrottleEvents alarm. | | alarmSystemErrors | DynamoDbTableSystemErrorsAlarm | The SystemErrors alarm. | | alarmThrottledPutRecordCount | DynamoDbTableThrottledPutRecordCountAlarm | The ThrottledPutRecordCount alarm. | | alarmWriteThrottleEvents | DynamoDbTableWriteThrottleEventsAlarm | The WriteThrottleEvents alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmAgeOfOldestUnreplicatedRecord`^Optional ```typescript public readonly alarmAgeOfOldestUnreplicatedRecord: DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm; ``` - *Type:* DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm The AgeOfOldestUnreplicatedRecord alarm. --- ##### `alarmFailedToReplicateRecordCount`^Optional ```typescript public readonly alarmFailedToReplicateRecordCount: DynamoDbTableFailedToReplicateRecordCountAlarm; ``` - *Type:* DynamoDbTableFailedToReplicateRecordCountAlarm The FailedToReplicateRecordCount alarm. --- ##### `alarmReadThrottleEvents`^Optional ```typescript public readonly alarmReadThrottleEvents: DynamoDbTableReadThrottleEventsAlarm; ``` - *Type:* DynamoDbTableReadThrottleEventsAlarm The ReadThrottleEvents alarm. --- ##### `alarmSystemErrors`^Optional ```typescript public readonly alarmSystemErrors: DynamoDbTableSystemErrorsAlarm; ``` - *Type:* DynamoDbTableSystemErrorsAlarm The SystemErrors alarm. --- ##### `alarmThrottledPutRecordCount`^Optional ```typescript public readonly alarmThrottledPutRecordCount: DynamoDbTableThrottledPutRecordCountAlarm; ``` - *Type:* DynamoDbTableThrottledPutRecordCountAlarm The ThrottledPutRecordCount alarm. --- ##### `alarmWriteThrottleEvents`^Optional ```typescript public readonly alarmWriteThrottleEvents: DynamoDbTableWriteThrottleEventsAlarm; ``` - *Type:* DynamoDbTableWriteThrottleEventsAlarm The WriteThrottleEvents alarm. --- ### DynamoDbTableSystemErrorsAlarm This alarm detects a sustained high number of system errors for the DynamoDB table requests. If you continue to get 5xx errors, open the {@link https://status.aws.amazon.com/ AWS Service Health Dashboard} to check for operational issues with the service. You can use this alarm to get notified in case there is a prolonged internal service issue from DynamoDB and it helps you correlate with the issue your client application is facing. Refer {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.MessagesAndCodes.http5xx Error handling for DynamoDB} for more information. The alarm is triggered when the number of system errors exceeds threshold. #### Initializers ```typescript import { DynamoDbTableSystemErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DynamoDbTableSystemErrorsAlarm(scope: IConstruct, id: string, props: DynamoDbTableSystemErrorsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DynamoDbTableSystemErrorsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DynamoDbTableSystemErrorsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DynamoDbTableSystemErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableSystemErrorsAlarm.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 { DynamoDbTableSystemErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableSystemErrorsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DynamoDbTableSystemErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableSystemErrorsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DynamoDbTableSystemErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableSystemErrorsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DynamoDbTableSystemErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableSystemErrorsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DynamoDbTableThrottledPutRecordCountAlarm This alarm detects the records getting throttled by your Kinesis data stream during the replication of change data capture to Kinesis. This throttling happens because of insufficient Kinesis data stream capacity. If you experience excessive and regular throttling, you might need to increase the number of Kinesis stream shards proportionally to the observed write throughput of your table. To learn more about determining the size of a Kinesis data stream, see {@link https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-streams.html#how-do-i-size-a-stream Determining the Initial Size of a Kinesis Data Stream}. The alarm is triggered when the number or records that were throttled exceeds the threshold. #### Initializers ```typescript import { DynamoDbTableThrottledPutRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DynamoDbTableThrottledPutRecordCountAlarm(scope: IConstruct, id: string, props: DynamoDbTableThrottledPutRecordCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DynamoDbTableThrottledPutRecordCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DynamoDbTableThrottledPutRecordCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DynamoDbTableThrottledPutRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableThrottledPutRecordCountAlarm.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 { DynamoDbTableThrottledPutRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableThrottledPutRecordCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DynamoDbTableThrottledPutRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableThrottledPutRecordCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DynamoDbTableThrottledPutRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableThrottledPutRecordCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DynamoDbTableThrottledPutRecordCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableThrottledPutRecordCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### DynamoDbTableWriteThrottleEventsAlarm This alarm detects if there are high number of read requests getting throttled for the DynamoDB table. To troubleshoot the issue, see {@link https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TroubleshootingThrottling.html Troubleshooting throttling issues in Amazon DynamoDB}. The alarm is triggered when the number of read requests exceeds the threshold. #### Initializers ```typescript import { DynamoDbTableWriteThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DynamoDbTableWriteThrottleEventsAlarm(scope: IConstruct, id: string, props: DynamoDbTableWriteThrottleEventsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | DynamoDbTableWriteThrottleEventsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* DynamoDbTableWriteThrottleEventsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { DynamoDbTableWriteThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableWriteThrottleEventsAlarm.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 { DynamoDbTableWriteThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableWriteThrottleEventsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { DynamoDbTableWriteThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableWriteThrottleEventsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { DynamoDbTableWriteThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableWriteThrottleEventsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { DynamoDbTableWriteThrottleEventsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' DynamoDbTableWriteThrottleEventsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### Ec2InstanceCpuUtilizationAlarm This alarm helps to monitor the CPU utilization of an EC2 instance. Depending on the application, consistently high utilization levels might be normal. But if performance is degraded, and the application is not constrained by disk I/O, memory, or network resources, then a maxed-out CPU might indicate a resource bottleneck or application performance problems. High CPU utilization might indicate that an upgrade to a more CPU intensive instance is required. If detailed monitoring is enabled, you can change the period to 60 seconds instead of 300 seconds. For more information, see Enable or turn off detailed monitoring for your instances. The alarm is triggered when the percentage exceeds % threshold. #### Initializers ```typescript import { Ec2InstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Ec2InstanceCpuUtilizationAlarm(scope: IConstruct, id: string, props: Ec2InstanceCpuUtilizationAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | Ec2InstanceCpuUtilizationAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* Ec2InstanceCpuUtilizationAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { Ec2InstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceCpuUtilizationAlarm.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 { Ec2InstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceCpuUtilizationAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Ec2InstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceCpuUtilizationAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { Ec2InstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceCpuUtilizationAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { Ec2InstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceCpuUtilizationAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### Ec2InstanceRecommendedAlarms A construct that creates the recommended alarms for an EC2 Instance. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EC2](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EC2) #### Initializers ```typescript import { Ec2InstanceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Ec2InstanceRecommendedAlarms(scope: Construct, id: string, props: Ec2InstanceRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | Ec2InstanceRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* Ec2InstanceRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { Ec2InstanceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceRecommendedAlarms.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. | | alarmCpuUtilization | Ec2InstanceCpuUtilizationAlarm | The CPUUtilization alarm. | | alarmStatusCheckFailed | Ec2InstanceStatusCheckFailedAlarm | The StatusCheckFailed alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmCpuUtilization`^Optional ```typescript public readonly alarmCpuUtilization: Ec2InstanceCpuUtilizationAlarm; ``` - *Type:* Ec2InstanceCpuUtilizationAlarm The CPUUtilization alarm. --- ##### `alarmStatusCheckFailed`^Optional ```typescript public readonly alarmStatusCheckFailed: Ec2InstanceStatusCheckFailedAlarm; ``` - *Type:* Ec2InstanceStatusCheckFailedAlarm The StatusCheckFailed alarm. --- ### Ec2InstanceStatusCheckFailedAlarm This alarm helps to monitor both system status checks and instance status checks. If either type of status check fails, then this alarm should be in ALARM state. The alarm is triggered when the status reported is greater or equal to threshold. #### Initializers ```typescript import { Ec2InstanceStatusCheckFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Ec2InstanceStatusCheckFailedAlarm(scope: IConstruct, id: string, props: Ec2InstanceStatusCheckFailedAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | Ec2InstanceStatusCheckFailedAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* Ec2InstanceStatusCheckFailedAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { Ec2InstanceStatusCheckFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceStatusCheckFailedAlarm.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 { Ec2InstanceStatusCheckFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceStatusCheckFailedAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Ec2InstanceStatusCheckFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceStatusCheckFailedAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { Ec2InstanceStatusCheckFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceStatusCheckFailedAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { Ec2InstanceStatusCheckFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' Ec2InstanceStatusCheckFailedAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### EcsServiceCpuUtilizationAlarm This alarm is used to detect high CPU utilization for the ECS service. Consistent high CPU utilization can indicate a resource bottleneck or application performance problems. The alarm is triggered when CPU utilization exceeds % threshold. #### Initializers ```typescript import { EcsServiceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EcsServiceCpuUtilizationAlarm(scope: IConstruct, id: string, props: EcsServiceCpuUtilizationAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | EcsServiceCpuUtilizationAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* EcsServiceCpuUtilizationAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { EcsServiceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceCpuUtilizationAlarm.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 { EcsServiceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceCpuUtilizationAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { EcsServiceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceCpuUtilizationAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { EcsServiceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceCpuUtilizationAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { EcsServiceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceCpuUtilizationAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### EcsServiceEphemeralStorageUtilizedAlarm This alarm is used to detect high ephemeral storage usage for the Fargate cluster. Consistent high ephemeral storage utilized can indicate that the disk is full and it might lead to failure of the container. The alarm is triggered when the storage utilized (GB) exceeds the threshold. #### Initializers ```typescript import { EcsServiceEphemeralStorageUtilizedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EcsServiceEphemeralStorageUtilizedAlarm(scope: IConstruct, id: string, props: EcsServiceEphemeralStorageUtilizedAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | EcsServiceEphemeralStorageUtilizedAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* EcsServiceEphemeralStorageUtilizedAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { EcsServiceEphemeralStorageUtilizedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceEphemeralStorageUtilizedAlarm.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 { EcsServiceEphemeralStorageUtilizedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceEphemeralStorageUtilizedAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { EcsServiceEphemeralStorageUtilizedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceEphemeralStorageUtilizedAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { EcsServiceEphemeralStorageUtilizedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceEphemeralStorageUtilizedAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { EcsServiceEphemeralStorageUtilizedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceEphemeralStorageUtilizedAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### EcsServiceMemoryUtilizationAlarm This alarm is used to detect high memory utilization for the ECS service. Consistent high memory utilization can indicate a resource bottleneck or application performance problems. The alarm is triggered when memory utilization exceeds % threshold. #### Initializers ```typescript import { EcsServiceMemoryUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EcsServiceMemoryUtilizationAlarm(scope: IConstruct, id: string, props: EcsServiceMemoryUtilizationAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | EcsServiceMemoryUtilizationAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* EcsServiceMemoryUtilizationAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { EcsServiceMemoryUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceMemoryUtilizationAlarm.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 { EcsServiceMemoryUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceMemoryUtilizationAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { EcsServiceMemoryUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceMemoryUtilizationAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { EcsServiceMemoryUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceMemoryUtilizationAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { EcsServiceMemoryUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceMemoryUtilizationAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### EcsServiceRecommendedAlarms A construct that creates the recommended alarms for an ECS service. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ECS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ECS) #### Initializers ```typescript import { EcsServiceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EcsServiceRecommendedAlarms(scope: Construct, id: string, props: EcsServiceRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | EcsServiceRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* EcsServiceRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { EcsServiceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceRecommendedAlarms.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. | | alarmCpuUtilization | EcsServiceCpuUtilizationAlarm | The CpuUtilization alarm. | | alarmEphemeralStorageUtilized | EcsServiceEphemeralStorageUtilizedAlarm | The EphemeralStorageUtilized alarm. | | alarmMemoryUtilization | EcsServiceMemoryUtilizationAlarm | The MemoryUtilization alarm. | | alarmRunningTaskCount | EcsServiceRunningTaskCountAlarm | The RunningTaskCount alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmCpuUtilization`^Optional ```typescript public readonly alarmCpuUtilization: EcsServiceCpuUtilizationAlarm; ``` - *Type:* EcsServiceCpuUtilizationAlarm The CpuUtilization alarm. --- ##### `alarmEphemeralStorageUtilized`^Optional ```typescript public readonly alarmEphemeralStorageUtilized: EcsServiceEphemeralStorageUtilizedAlarm; ``` - *Type:* EcsServiceEphemeralStorageUtilizedAlarm The EphemeralStorageUtilized alarm. --- ##### `alarmMemoryUtilization`^Optional ```typescript public readonly alarmMemoryUtilization: EcsServiceMemoryUtilizationAlarm; ``` - *Type:* EcsServiceMemoryUtilizationAlarm The MemoryUtilization alarm. --- ##### `alarmRunningTaskCount`^Optional ```typescript public readonly alarmRunningTaskCount: EcsServiceRunningTaskCountAlarm; ``` - *Type:* EcsServiceRunningTaskCountAlarm The RunningTaskCount alarm. --- ### EcsServiceRunningTaskCountAlarm This alarm helps you detect a low running task count of the ECS service. If the running task count is too low, it can can indicate that the application can’t handle the service load and it might lead to performance issues. If there is no running task, the Amazon ECS service might be unavailable or there might be deployment issues. The alarm is triggered when the number of running tasks is less than or equal to threshold. #### Initializers ```typescript import { EcsServiceRunningTaskCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EcsServiceRunningTaskCountAlarm(scope: IConstruct, id: string, props: EcsServiceRunningTaskCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | EcsServiceRunningTaskCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* EcsServiceRunningTaskCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { EcsServiceRunningTaskCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceRunningTaskCountAlarm.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 { EcsServiceRunningTaskCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceRunningTaskCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { EcsServiceRunningTaskCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceRunningTaskCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { EcsServiceRunningTaskCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceRunningTaskCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { EcsServiceRunningTaskCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EcsServiceRunningTaskCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### EfsFileSystemBurstCreditBalanceAlarm This alarm helps in ensuring that there is available burst credit balance for the file system usage. When there is no available burst credit, applications access to the the file system will be limited due to low throughput. If the metric drops to 0 consistently, consider changing the throughput mode to Elastic or Provisioned throughput mode. The alarm is triggered when the percentage is lower or equals the threshold. #### Initializers ```typescript import { EfsFileSystemBurstCreditBalanceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EfsFileSystemBurstCreditBalanceAlarm(scope: IConstruct, id: string, props: EfsFileSystemBurstCreditBalanceAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | EfsFileSystemBurstCreditBalanceAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* EfsFileSystemBurstCreditBalanceAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { EfsFileSystemBurstCreditBalanceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemBurstCreditBalanceAlarm.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 { EfsFileSystemBurstCreditBalanceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemBurstCreditBalanceAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { EfsFileSystemBurstCreditBalanceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemBurstCreditBalanceAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { EfsFileSystemBurstCreditBalanceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemBurstCreditBalanceAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { EfsFileSystemBurstCreditBalanceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemBurstCreditBalanceAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### EfsFileSystemPercentIOLimitAlarm This alarm helps in ensuring that the workload stays within the I/O limit available to the file system. If the metric reaches its I/O limit consistently, consider moving the application to a file system that uses Max I/O performance as mode. For troubleshooting, check clients that are connected to the file system and applications of the clients that throttles the file system. The alarm is triggered when the percentage exceed or equals % threshold. #### Initializers ```typescript import { EfsFileSystemPercentIOLimitAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EfsFileSystemPercentIOLimitAlarm(scope: IConstruct, id: string, props: EfsFileSystemPercentIOLimitAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | EfsFileSystemPercentIOLimitAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* EfsFileSystemPercentIOLimitAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { EfsFileSystemPercentIOLimitAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemPercentIOLimitAlarm.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 { EfsFileSystemPercentIOLimitAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemPercentIOLimitAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { EfsFileSystemPercentIOLimitAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemPercentIOLimitAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { EfsFileSystemPercentIOLimitAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemPercentIOLimitAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { EfsFileSystemPercentIOLimitAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemPercentIOLimitAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### EfsFileSystemRecommendedAlarms A construct that creates the recommended alarms for an EFS FileSystem. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EFS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EFS) #### Initializers ```typescript import { EfsFileSystemRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EfsFileSystemRecommendedAlarms(scope: Construct, id: string, props: EfsFileSystemRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | EfsFileSystemRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* EfsFileSystemRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { EfsFileSystemRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' EfsFileSystemRecommendedAlarms.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. | | alarmBurstCreditBalance | EfsFileSystemBurstCreditBalanceAlarm | The BurstCreditBalance alarm. | | alarmPercentIOLimit | EfsFileSystemPercentIOLimitAlarm | The PercentIOLimit alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmBurstCreditBalance`^Optional ```typescript public readonly alarmBurstCreditBalance: EfsFileSystemBurstCreditBalanceAlarm; ``` - *Type:* EfsFileSystemBurstCreditBalanceAlarm The BurstCreditBalance alarm. --- ##### `alarmPercentIOLimit`^Optional ```typescript public readonly alarmPercentIOLimit: EfsFileSystemPercentIOLimitAlarm; ``` - *Type:* EfsFileSystemPercentIOLimitAlarm The PercentIOLimit alarm. --- ### ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm This alarm helps you monitor the memory utilization of your cluster. When your DatabaseMemoryUsagePercentage reaches 100%, the Redis OSS maxmemory policy is triggered and evictions might occur based on the policy selected. If no object in the cache matches the eviction policy, write operations fail. Some workloads expect or rely on evictions, but if not, you will need to increase the memory capacity of your cluster. You can scale your cluster out by adding more primary nodes, or scale it up by using a larger node type. Refer to {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} for details. The alarm is triggered when the percentage exceeds % threshold. #### Initializers ```typescript import { ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm(scope: IConstruct, id: string, props: ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm.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 { ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ElastiCacheClusterEngineCpuUtilizationAlarm This alarm helps to monitor the CPU utilization of a Redis OSS engine thread within the ElastiCache instance. Common reasons for high engine CPU are long-running commands that consume high CPU, a high number of requests, an increase of new client connection requests in a short time period, and high evictions when the cache doesn't have enough memory to hold new data. You should consider {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} by adding more nodes or scaling up your instance type. The alarm is triggered when the percentage exceeds the threshold. #### Initializers ```typescript import { ElastiCacheClusterEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheClusterEngineCpuUtilizationAlarm(scope: IConstruct, id: string, props: ElastiCacheClusterEngineCpuUtilizationAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ElastiCacheClusterEngineCpuUtilizationAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ElastiCacheClusterEngineCpuUtilizationAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ElastiCacheClusterEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterEngineCpuUtilizationAlarm.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 { ElastiCacheClusterEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterEngineCpuUtilizationAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ElastiCacheClusterEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterEngineCpuUtilizationAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ElastiCacheClusterEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterEngineCpuUtilizationAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ElastiCacheClusterEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterEngineCpuUtilizationAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ElastiCacheClusterRecommendedAlarms A construct that creates the recommended alarms for an ElastiCache CfnCacheCluster. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache) #### Initializers ```typescript import { ElastiCacheClusterRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheClusterRecommendedAlarms(scope: Construct, id: string, props: ElastiCacheClusterRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ElastiCacheClusterRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ElastiCacheClusterRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { ElastiCacheClusterRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterRecommendedAlarms.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. | | alarmDatabaseMemoryUsagePercentage | ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm | The DatabaseMemoryUsagePercentage alarm. | | alarmEngineCpuUtilization | ElastiCacheClusterEngineCpuUtilizationAlarm | The EngineCpuUtilization alarm. | | alarmReplicationLag | ElastiCacheClusterReplicationLagAlarm | The ReplicationLag alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmDatabaseMemoryUsagePercentage`^Optional ```typescript public readonly alarmDatabaseMemoryUsagePercentage: ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm; ``` - *Type:* ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm The DatabaseMemoryUsagePercentage alarm. --- ##### `alarmEngineCpuUtilization`^Optional ```typescript public readonly alarmEngineCpuUtilization: ElastiCacheClusterEngineCpuUtilizationAlarm; ``` - *Type:* ElastiCacheClusterEngineCpuUtilizationAlarm The EngineCpuUtilization alarm. --- ##### `alarmReplicationLag`^Optional ```typescript public readonly alarmReplicationLag: ElastiCacheClusterReplicationLagAlarm; ``` - *Type:* ElastiCacheClusterReplicationLagAlarm The ReplicationLag alarm. --- ### ElastiCacheClusterReplicationLagAlarm This alarm helps to monitor the replication health of your ElastiCache cluster. A high replication lag means that the primary node or the replica can't keep up the pace of the replication. If your write activity is too high, consider scaling your cluster out by adding more primary nodes, or scaling it up by using a larger node type. Refer to {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} for details. If your read replicas are overloaded by the amount of read requests, consider adding more read replicas. The alarm is triggered when the number of milliseconds exceeds the threshold. #### Initializers ```typescript import { ElastiCacheClusterReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheClusterReplicationLagAlarm(scope: IConstruct, id: string, props: ElastiCacheClusterReplicationLagAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ElastiCacheClusterReplicationLagAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ElastiCacheClusterReplicationLagAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ElastiCacheClusterReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterReplicationLagAlarm.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 { ElastiCacheClusterReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterReplicationLagAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ElastiCacheClusterReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterReplicationLagAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ElastiCacheClusterReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterReplicationLagAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ElastiCacheClusterReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheClusterReplicationLagAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm This alarm helps you monitor the memory utilization of your cluster. When your DatabaseMemoryUsagePercentage reaches 100%, the Redis OSS maxmemory policy is triggered and evictions might occur based on the policy selected. If no object in the cache matches the eviction policy, write operations fail. Some workloads expect or rely on evictions, but if not, you will need to increase the memory capacity of your cluster. You can scale your cluster out by adding more primary nodes, or scale it up by using a larger node type. Refer to {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} for details. The alarm is triggered when the percentage exceeds % threshold. #### Initializers ```typescript import { ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm(scope: IConstruct, id: string, props: ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm.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 { ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ElastiCacheReplicationGroupEngineCpuUtilizationAlarm This alarm helps to monitor the CPU utilization of a Redis OSS engine thread within the ElastiCache instance. Common reasons for high engine CPU are long-running commands that consume high CPU, a high number of requests, an increase of new client connection requests in a short time period, and high evictions when the cache doesn't have enough memory to hold new data. You should consider {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} by adding more nodes or scaling up your instance type. The alarm is triggered when the percentage exceeds the threshold. #### Initializers ```typescript import { ElastiCacheReplicationGroupEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheReplicationGroupEngineCpuUtilizationAlarm(scope: IConstruct, id: string, props: ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ElastiCacheReplicationGroupEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupEngineCpuUtilizationAlarm.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 { ElastiCacheReplicationGroupEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupEngineCpuUtilizationAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ElastiCacheReplicationGroupEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupEngineCpuUtilizationAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ElastiCacheReplicationGroupEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupEngineCpuUtilizationAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ElastiCacheReplicationGroupEngineCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupEngineCpuUtilizationAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ElastiCacheReplicationGroupRecommendedAlarms A construct that creates the recommended alarms for an ElastiCache CfnReplicationGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache) #### Initializers ```typescript import { ElastiCacheReplicationGroupRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheReplicationGroupRecommendedAlarms(scope: Construct, id: string, props: ElastiCacheReplicationGroupRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ElastiCacheReplicationGroupRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ElastiCacheReplicationGroupRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { ElastiCacheReplicationGroupRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupRecommendedAlarms.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. | | alarmDatabaseMemoryUsagePercentage | ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm | The DatabaseMemoryUsagePercentage alarm. | | alarmEngineCpuUtilization | ElastiCacheReplicationGroupEngineCpuUtilizationAlarm | The EngineCpuUtilization alarm. | | alarmReplicationLag | ElastiCacheReplicationGroupReplicationLagAlarm | The ReplicationLag alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmDatabaseMemoryUsagePercentage`^Optional ```typescript public readonly alarmDatabaseMemoryUsagePercentage: ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm; ``` - *Type:* ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm The DatabaseMemoryUsagePercentage alarm. --- ##### `alarmEngineCpuUtilization`^Optional ```typescript public readonly alarmEngineCpuUtilization: ElastiCacheReplicationGroupEngineCpuUtilizationAlarm; ``` - *Type:* ElastiCacheReplicationGroupEngineCpuUtilizationAlarm The EngineCpuUtilization alarm. --- ##### `alarmReplicationLag`^Optional ```typescript public readonly alarmReplicationLag: ElastiCacheReplicationGroupReplicationLagAlarm; ``` - *Type:* ElastiCacheReplicationGroupReplicationLagAlarm The ReplicationLag alarm. --- ### ElastiCacheReplicationGroupReplicationLagAlarm This alarm helps to monitor the replication health of your ElastiCache cluster. A high replication lag means that the primary node or the replica can't keep up the pace of the replication. If your write activity is too high, consider scaling your cluster out by adding more primary nodes, or scaling it up by using a larger node type. Refer to {@link https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html Scaling ElastiCache for Redis OSS clusters} for details. If your read replicas are overloaded by the amount of read requests, consider adding more read replicas. The alarm is triggered when the number of milliseconds exceeds the threshold. #### Initializers ```typescript import { ElastiCacheReplicationGroupReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheReplicationGroupReplicationLagAlarm(scope: IConstruct, id: string, props: ElastiCacheReplicationGroupReplicationLagAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | ElastiCacheReplicationGroupReplicationLagAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ElastiCacheReplicationGroupReplicationLagAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { ElastiCacheReplicationGroupReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupReplicationLagAlarm.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 { ElastiCacheReplicationGroupReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupReplicationLagAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { ElastiCacheReplicationGroupReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupReplicationLagAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { ElastiCacheReplicationGroupReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupReplicationLagAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { ElastiCacheReplicationGroupReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' ElastiCacheReplicationGroupReplicationLagAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### FargateService An extension for the FargateService construct that provides methods to create recommended alarms. #### Initializers ```typescript import { FargateService } from '@renovosolutions/cdk-library-cloudwatch-alarms' new FargateService(scope: Construct, id: string, props: FargateServiceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_ecs.FargateServiceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_ecs.FargateServiceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addLifecycleHook | Add a deployment lifecycle hook target. | | addVolume | Adds a volume to the Service. | | associateCloudMapService | Associates this service with a CloudMap service. | | attachToApplicationTargetGroup | This method is called to attach this service to an Application Load Balancer. | | attachToClassicLB | Registers the service as a target of a Classic Load Balancer (CLB). | | attachToNetworkTargetGroup | This method is called to attach this service to a Network Load Balancer. | | autoScaleTaskCount | An attribute representing the minimum and maximum task count for an AutoScalingGroup. | | enableCloudMap | Enable CloudMap service discovery for the service. | | enableDeploymentAlarms | Enable Deployment Alarms which take advantage of arbitrary alarms and configure them after service initialization. | | enableServiceConnect | Enable Service Connect on this service. | | forceNewDeployment | Forces a new deployment of the service. | | isUsingECSDeploymentController | Checks if the service is using the ECS deployment controller. | | loadBalancerTarget | Return a load balancing target for a specific container and port. | | metric | This method returns the specified CloudWatch metric name for this service. | | metricCpuUtilization | This method returns the CloudWatch metric for this service's CPU utilization. | | metricMemoryUtilization | This method returns the CloudWatch metric for this service's memory utilization. | | registerLoadBalancerTargets | Use this function to create all load balancer targets to be registered in this service, add them to target groups, and attach target groups to listeners accordingly. | | alarmCpuUtilization | Creates an alarm that monitors the CPU utilization for the Fargate service. | | alarmEphemeralStorageUtilized | Creates an alarm that monitors the ephemeral storage utilized for the Fargate service. | | alarmMemoryUtilization | Creates an alarm that monitors the memory utilization for the Fargate service. | | alarmRunningTaskCount | Creates an alarm that monitors the number of task running. | | applyRecommendedAlarms | Creates the recommended alarms for the ECS service. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addLifecycleHook` ```typescript public addLifecycleHook(target: IDeploymentLifecycleHookTarget): void ``` Add a deployment lifecycle hook target. ###### `target`^Required - *Type:* aws-cdk-lib.aws_ecs.IDeploymentLifecycleHookTarget The lifecycle hook target to add. --- ##### `addVolume` ```typescript public addVolume(volume: ServiceManagedVolume): void ``` Adds a volume to the Service. ###### `volume`^Required - *Type:* aws-cdk-lib.aws_ecs.ServiceManagedVolume --- ##### `associateCloudMapService` ```typescript public associateCloudMapService(options: AssociateCloudMapServiceOptions): void ``` Associates this service with a CloudMap service. ###### `options`^Required - *Type:* aws-cdk-lib.aws_ecs.AssociateCloudMapServiceOptions --- ##### `attachToApplicationTargetGroup` ```typescript public attachToApplicationTargetGroup(targetGroup: IApplicationTargetGroup): LoadBalancerTargetProps ``` This method is called to attach this service to an Application Load Balancer. Don't call this function directly. Instead, call `listener.addTargets()` to add this service to a load balancer. ###### `targetGroup`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IApplicationTargetGroup --- ##### `attachToClassicLB` ```typescript public attachToClassicLB(loadBalancer: LoadBalancer): void ``` Registers the service as a target of a Classic Load Balancer (CLB). Don't call this. Call `loadBalancer.addTarget()` instead. ###### `loadBalancer`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancing.LoadBalancer --- ##### `attachToNetworkTargetGroup` ```typescript public attachToNetworkTargetGroup(targetGroup: INetworkTargetGroup): LoadBalancerTargetProps ``` This method is called to attach this service to a Network Load Balancer. Don't call this function directly. Instead, call `listener.addTargets()` to add this service to a load balancer. ###### `targetGroup`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroup --- ##### `autoScaleTaskCount` ```typescript public autoScaleTaskCount(props: EnableScalingProps): ScalableTaskCount ``` An attribute representing the minimum and maximum task count for an AutoScalingGroup. ###### `props`^Required - *Type:* aws-cdk-lib.aws_applicationautoscaling.EnableScalingProps --- ##### `enableCloudMap` ```typescript public enableCloudMap(options: CloudMapOptions): Service ``` Enable CloudMap service discovery for the service. ###### `options`^Required - *Type:* aws-cdk-lib.aws_ecs.CloudMapOptions --- ##### `enableDeploymentAlarms` ```typescript public enableDeploymentAlarms(alarmNames: string[], options?: DeploymentAlarmOptions): void ``` Enable Deployment Alarms which take advantage of arbitrary alarms and configure them after service initialization. If you have already enabled deployment alarms, this function can be used to tell ECS about additional alarms that should interrupt a deployment. New alarms specified in subsequent calls of this function will be appended to the existing list of alarms. The same Alarm Behavior must be used on all deployment alarms. If you specify different AlarmBehavior values in multiple calls to this function, or the Alarm Behavior used here doesn't match the one used in the service constructor, an error will be thrown. If the alarm's metric references the service, you cannot pass `Alarm.alarmName` here. That will cause a circular dependency between the service and its deployment alarm. See this package's README for options to alarm on service metrics, and avoid this circular dependency. ###### `alarmNames`^Required - *Type:* string[] --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_ecs.DeploymentAlarmOptions --- ##### `enableServiceConnect` ```typescript public enableServiceConnect(config?: ServiceConnectProps): void ``` Enable Service Connect on this service. ###### `config`^Optional - *Type:* aws-cdk-lib.aws_ecs.ServiceConnectProps --- ##### `forceNewDeployment` ```typescript public forceNewDeployment(nonce?: string): void ``` Forces a new deployment of the service. This can be used to trigger a deployment without changing the task definition or desired count. ECS will start a new deployment even if there are no changes to the service configuration. **Important:** When called without a nonce, a timestamp is generated automatically, which means every `cdk synth` produces a different template and every `cdk deploy` triggers a new deployment regardless of whether any code has changed. To avoid this, provide a stable nonce value that only changes when you intentionally want to force a redeployment (e.g., an image digest or a version string). ###### `nonce`^Optional - *Type:* string A unique string (1-255 characters) that signals ECS to start a new deployment. If not provided, a timestamp-based nonce is generated. --- ##### `isUsingECSDeploymentController` ```typescript public isUsingECSDeploymentController(): boolean ``` Checks if the service is using the ECS deployment controller. ##### `loadBalancerTarget` ```typescript public loadBalancerTarget(options: LoadBalancerTargetOptions): IEcsLoadBalancerTarget ``` Return a load balancing target for a specific container and port. Use this function to create a load balancer target if you want to load balance to another container than the first essential container or the first mapped port on the container. Use the return value of this function where you would normally use a load balancer target, instead of the `Service` object itself. *Example* ```typescript declare const listener: elbv2.ApplicationListener; declare const service: ecs.BaseService; listener.addTargets('ECS', { port: 80, targets: [service.loadBalancerTarget({ containerName: 'MyContainer', containerPort: 1234, })], }); ``` ###### `options`^Required - *Type:* aws-cdk-lib.aws_ecs.LoadBalancerTargetOptions --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` This method returns the specified CloudWatch metric name for this service. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCpuUtilization` ```typescript public metricCpuUtilization(props?: MetricOptions): Metric ``` This method returns the CloudWatch metric for this service's CPU utilization. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricMemoryUtilization` ```typescript public metricMemoryUtilization(props?: MetricOptions): Metric ``` This method returns the CloudWatch metric for this service's memory utilization. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `registerLoadBalancerTargets` ```typescript public registerLoadBalancerTargets(targets: ...EcsTarget[]): void ``` Use this function to create all load balancer targets to be registered in this service, add them to target groups, and attach target groups to listeners accordingly. Alternatively, you can use `listener.addTargets()` to create targets and add them to target groups. *Example* ```typescript declare const listener: elbv2.ApplicationListener; declare const service: ecs.BaseService; service.registerLoadBalancerTargets( { containerName: 'web', containerPort: 80, newTargetGroupId: 'ECS', listener: ecs.ListenerConfig.applicationListener(listener, { protocol: elbv2.ApplicationProtocol.HTTPS }), }, ) ``` ###### `targets`^Required - *Type:* ...aws-cdk-lib.aws_ecs.EcsTarget[] --- ##### `alarmCpuUtilization` ```typescript public alarmCpuUtilization(props?: EcsCpuUtilizationAlarmConfig): EcsServiceCpuUtilizationAlarm ``` Creates an alarm that monitors the CPU utilization for the Fargate service. ###### `props`^Optional - *Type:* EcsCpuUtilizationAlarmConfig --- ##### `alarmEphemeralStorageUtilized` ```typescript public alarmEphemeralStorageUtilized(props: EcsEphemeralStorageUtilizedAlarmConfig): EcsServiceEphemeralStorageUtilizedAlarm ``` Creates an alarm that monitors the ephemeral storage utilized for the Fargate service. ###### `props`^Required - *Type:* EcsEphemeralStorageUtilizedAlarmConfig --- ##### `alarmMemoryUtilization` ```typescript public alarmMemoryUtilization(props?: EcsMemoryUtilizationAlarmConfig): EcsServiceMemoryUtilizationAlarm ``` Creates an alarm that monitors the memory utilization for the Fargate service. ###### `props`^Optional - *Type:* EcsMemoryUtilizationAlarmConfig --- ##### `alarmRunningTaskCount` ```typescript public alarmRunningTaskCount(props?: EcsRunningTaskCountAlarmConfig): EcsServiceRunningTaskCountAlarm ``` Creates an alarm that monitors the number of task running. ###### `props`^Optional - *Type:* EcsRunningTaskCountAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: EcsServiceRecommendedAlarmsConfig): EcsServiceRecommendedAlarms ``` Creates the recommended alarms for the ECS service. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ECS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ECS) ###### `props`^Required - *Type:* EcsServiceRecommendedAlarmsConfig --- #### 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. | | fromServiceArnWithCluster | Import an existing ECS/Fargate Service using the service cluster format. | | fromFargateServiceArn | Imports from the specified service ARN. | | fromFargateServiceAttributes | Imports from the specified service attributes. | --- ##### `isConstruct` ```typescript import { FargateService } from '@renovosolutions/cdk-library-cloudwatch-alarms' FargateService.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 { FargateService } from '@renovosolutions/cdk-library-cloudwatch-alarms' FargateService.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { FargateService } from '@renovosolutions/cdk-library-cloudwatch-alarms' FargateService.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromServiceArnWithCluster` ```typescript import { FargateService } from '@renovosolutions/cdk-library-cloudwatch-alarms' FargateService.fromServiceArnWithCluster(scope: Construct, id: string, serviceArn: string) ``` Import an existing ECS/Fargate Service using the service cluster format. The format is the "new" format "arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name". > [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `serviceArn`^Required - *Type:* string --- ##### `fromFargateServiceArn` ```typescript import { FargateService } from '@renovosolutions/cdk-library-cloudwatch-alarms' FargateService.fromFargateServiceArn(scope: Construct, id: string, fargateServiceArn: string) ``` Imports from the specified service ARN. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `fargateServiceArn`^Required - *Type:* string --- ##### `fromFargateServiceAttributes` ```typescript import { FargateService } from '@renovosolutions/cdk-library-cloudwatch-alarms' FargateService.fromFargateServiceAttributes(scope: Construct, id: string, attrs: FargateServiceAttributes) ``` Imports from the specified service attributes. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_ecs.FargateServiceAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | cluster | aws-cdk-lib.aws_ecs.ICluster | The cluster that hosts the service. | | connections | aws-cdk-lib.aws_ec2.Connections | The security groups which manage the allowed network traffic for the service. | | serviceArn | string | The Amazon Resource Name (ARN) of the service. | | serviceName | string | The name of the service. | | serviceRef | aws-cdk-lib.interfaces.aws_ecs.ServiceReference | A reference to this service. | | taskDefinition | aws-cdk-lib.aws_ecs.TaskDefinition | The task definition to use for tasks in the service. | | cloudMapService | aws-cdk-lib.aws_servicediscovery.IService | The CloudMap service created for this service, if any. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `cluster`^Required ```typescript public readonly cluster: ICluster; ``` - *Type:* aws-cdk-lib.aws_ecs.ICluster The cluster that hosts the service. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The security groups which manage the allowed network traffic for the service. --- ##### `serviceArn`^Required ```typescript public readonly serviceArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of the service. --- ##### `serviceName`^Required ```typescript public readonly serviceName: string; ``` - *Type:* string The name of the service. --- ##### `serviceRef`^Required ```typescript public readonly serviceRef: ServiceReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_ecs.ServiceReference A reference to this service. --- ##### `taskDefinition`^Required ```typescript public readonly taskDefinition: TaskDefinition; ``` - *Type:* aws-cdk-lib.aws_ecs.TaskDefinition The task definition to use for tasks in the service. --- ##### `cloudMapService`^Optional ```typescript public readonly cloudMapService: IService; ``` - *Type:* aws-cdk-lib.aws_servicediscovery.IService The CloudMap service created for this service, if any. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### FileSystem An extension for the FileSystem construct that provides methods to create recommended alarms. #### Initializers ```typescript import { FileSystem } from '@renovosolutions/cdk-library-cloudwatch-alarms' new FileSystem(scope: Construct, id: string, props: FileSystemProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_efs.FileSystemProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_efs.FileSystemProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAccessPoint | create access point from this filesystem. | | addToResourcePolicy | Adds a statement to the resource policy associated with this file system. | | grant | Grant the actions defined in actions to the given grantee on this File System resource. | | grantRead | Grant read permissions for this file system to an IAM principal. | | grantReadWrite | Grant read and write permissions for this file system to an IAM principal. | | grantRootAccess | As root user, grant read and write permissions for this file system to an IAM principal. | | alarmBurstCreditBalance | Creates an alarm that monitors the BurstCreditBalance for the EFS fileSystem. | | alarmPercentIOLimit | Creates an alarm that monitors the PercentIOLimit for the EFS fileSystem. | | applyRecommendedAlarms | Creates the recommended alarms for the EFS FileSystem. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAccessPoint` ```typescript public addAccessPoint(id: string, accessPointOptions?: AccessPointOptions): AccessPoint ``` create access point from this filesystem. ###### `id`^Required - *Type:* string --- ###### `accessPointOptions`^Optional - *Type:* aws-cdk-lib.aws_efs.AccessPointOptions --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the resource policy associated with this file system. A resource policy will be automatically created upon the first call to `addToResourcePolicy`. Note that this does not work with imported file systems. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement The policy statement to add. --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grant the actions defined in actions to the given grantee on this File System resource. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable Principal to grant right to. --- ###### `actions`^Required - *Type:* ...string[] The actions to grant. --- ##### `grantRead` ```typescript public grantRead(grantee: IGrantable): Grant ``` Grant read permissions for this file system to an IAM principal. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant read to. --- ##### `grantReadWrite` ```typescript public grantReadWrite(grantee: IGrantable): Grant ``` Grant read and write permissions for this file system to an IAM principal. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant read and write to. --- ##### `grantRootAccess` ```typescript public grantRootAccess(grantee: IGrantable): Grant ``` As root user, grant read and write permissions for this file system to an IAM principal. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant root access to. --- ##### `alarmBurstCreditBalance` ```typescript public alarmBurstCreditBalance(props?: EfsBurstCreditBalanceAlarmConfig): EfsFileSystemBurstCreditBalanceAlarm ``` Creates an alarm that monitors the BurstCreditBalance for the EFS fileSystem. ###### `props`^Optional - *Type:* EfsBurstCreditBalanceAlarmConfig --- ##### `alarmPercentIOLimit` ```typescript public alarmPercentIOLimit(props?: EfsPercentIOLimitAlarmConfig): EfsFileSystemPercentIOLimitAlarm ``` Creates an alarm that monitors the PercentIOLimit for the EFS fileSystem. ###### `props`^Optional - *Type:* EfsPercentIOLimitAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props?: EfsFileSystemRecommendedAlarmsConfig): EfsFileSystemRecommendedAlarms ``` Creates the recommended alarms for the EFS FileSystem. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EFS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EFS) ###### `props`^Optional - *Type:* EfsFileSystemRecommendedAlarmsConfig --- #### 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. | | fromFileSystemAttributes | Import an existing File System from the given properties. | --- ##### `isConstruct` ```typescript import { FileSystem } from '@renovosolutions/cdk-library-cloudwatch-alarms' FileSystem.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 { FileSystem } from '@renovosolutions/cdk-library-cloudwatch-alarms' FileSystem.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { FileSystem } from '@renovosolutions/cdk-library-cloudwatch-alarms' FileSystem.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromFileSystemAttributes` ```typescript import { FileSystem } from '@renovosolutions/cdk-library-cloudwatch-alarms' FileSystem.fromFileSystemAttributes(scope: Construct, id: string, attrs: FileSystemAttributes) ``` Import an existing File System from the given properties. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_efs.FileSystemAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | connections | aws-cdk-lib.aws_ec2.Connections | The security groups/rules used to allow network connections to the file system. | | fileSystemArn | string | The ARN of the file system. | | fileSystemId | string | The ID of the file system, assigned by Amazon EFS. | | fileSystemRef | aws-cdk-lib.interfaces.aws_efs.FileSystemReference | A reference to a FileSystem resource. | | mountTargetsAvailable | constructs.IDependable | Dependable that can be depended upon to ensure the mount targets of the filesystem are ready. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The security groups/rules used to allow network connections to the file system. --- ##### `fileSystemArn`^Required ```typescript public readonly fileSystemArn: string; ``` - *Type:* string The ARN of the file system. --- ##### `fileSystemId`^Required ```typescript public readonly fileSystemId: string; ``` - *Type:* string The ID of the file system, assigned by Amazon EFS. --- ##### `fileSystemRef`^Required ```typescript public readonly fileSystemRef: FileSystemReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_efs.FileSystemReference A reference to a FileSystem resource. --- ##### `mountTargetsAvailable`^Required ```typescript public readonly mountTargetsAvailable: IDependable; ``` - *Type:* constructs.IDependable Dependable that can be depended upon to ensure the mount targets of the filesystem are ready. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_PORT | number | The default port File System listens on. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `DEFAULT_PORT`^Required ```typescript public readonly DEFAULT_PORT: number; ``` - *Type:* number The default port File System listens on. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### Function An extension of the Lambda function construct that provides methods to create recommended alarms. #### Initializers ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Function(scope: Construct, id: string, props: FunctionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_lambda.FunctionProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_lambda.FunctionProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addEventSource | Adds an event source to this function. | | addEventSourceMapping | Adds an event source that maps to this AWS Lambda function. | | addFunctionUrl | Adds a url to this lambda function. | | addPermission | Adds a permission to the Lambda resource policy. | | addToRolePolicy | Adds a statement to the IAM role assumed by the instance. | | configureAsyncInvoke | Configures options for asynchronous invocation. | | considerWarningOnInvokeFunctionPermissions | A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function. | | grantInvoke | Grant the given identity permissions to invoke this Lambda. | | grantInvokeCompositePrincipal | Grant multiple principals the ability to invoke this Lambda via CompositePrincipal. | | grantInvokeLatestVersion | Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda. | | grantInvokeUrl | Grant the given identity permissions to invoke this Lambda Function URL. | | grantInvokeVersion | Grant the given identity permissions to invoke the given version of this Lambda. | | metric | Return the given named metric for this Function. | | metricDuration | How long execution of this Lambda takes. | | metricErrors | How many invocations of this Lambda fail. | | metricInvocations | How often this Lambda is invoked. | | metricThrottles | How often this Lambda is throttled. | | addAlias | Defines an alias for this function. | | addEnvironment | Adds an environment variable to this Lambda function. | | addLayers | Adds one or more Lambda Layers to this Lambda function. | | invalidateVersionBasedOn | Mix additional information into the hash of the Version object. | | alarmConcurrentExecutions | Creates an alarm that monitors the number of concurrent executions. | | alarmDuration | Creates an alarm that monitors the duration of the function invocations. | | alarmErrors | Creates an alarm that monitors the number of errors. | | alarmThrottles | Creates an alarm that monitors the number of throttles. | | applyRecommendedAlarms | Creates recommended alarms for the Lambda function. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addEventSource` ```typescript public addEventSource(source: IEventSource): void ``` Adds an event source to this function. Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module. The following example adds an SQS Queue as an event source: ``` import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources'; myFunction.addEventSource(new SqsEventSource(myQueue)); ``` ###### `source`^Required - *Type:* aws-cdk-lib.aws_lambda.IEventSource --- ##### `addEventSourceMapping` ```typescript public addEventSourceMapping(id: string, options: EventSourceMappingOptions): EventSourceMapping ``` Adds an event source that maps to this AWS Lambda function. ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_lambda.EventSourceMappingOptions --- ##### `addFunctionUrl` ```typescript public addFunctionUrl(options?: FunctionUrlOptions): FunctionUrl ``` Adds a url to this lambda function. ###### `options`^Optional - *Type:* aws-cdk-lib.aws_lambda.FunctionUrlOptions --- ##### `addPermission` ```typescript public addPermission(id: string, permission: Permission): void ``` Adds a permission to the Lambda resource policy. > [Permission for details.](Permission for details.) ###### `id`^Required - *Type:* string The id for the permission construct. --- ###### `permission`^Required - *Type:* aws-cdk-lib.aws_lambda.Permission The permission to grant to this Lambda function. --- ##### `addToRolePolicy` ```typescript public addToRolePolicy(statement: PolicyStatement): void ``` Adds a statement to the IAM role assumed by the instance. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement --- ##### `configureAsyncInvoke` ```typescript public configureAsyncInvoke(options: EventInvokeConfigOptions): void ``` Configures options for asynchronous invocation. ###### `options`^Required - *Type:* aws-cdk-lib.aws_lambda.EventInvokeConfigOptions --- ##### `considerWarningOnInvokeFunctionPermissions` ```typescript public considerWarningOnInvokeFunctionPermissions(scope: Construct, action: string): void ``` A warning will be added to functions under the following conditions: - permissions that include `lambda:InvokeFunction` are added to the unqualified function. function.currentVersion is invoked before or after the permission is created. This applies only to permissions on Lambda functions, not versions or aliases. This function is overridden as a noOp for QualifiedFunctionBase. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `action`^Required - *Type:* string --- ##### `grantInvoke` ```typescript public grantInvoke(grantee: IGrantable): Grant ``` Grant the given identity permissions to invoke this Lambda. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `grantInvokeCompositePrincipal` ```typescript public grantInvokeCompositePrincipal(compositePrincipal: CompositePrincipal): Grant[] ``` Grant multiple principals the ability to invoke this Lambda via CompositePrincipal. [disable-awslint:no-grants] ###### `compositePrincipal`^Required - *Type:* aws-cdk-lib.aws_iam.CompositePrincipal --- ##### `grantInvokeLatestVersion` ```typescript public grantInvokeLatestVersion(grantee: IGrantable): Grant ``` Grant the given identity permissions to invoke the $LATEST version or unqualified version of this Lambda. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `grantInvokeUrl` ```typescript public grantInvokeUrl(grantee: IGrantable): Grant ``` Grant the given identity permissions to invoke this Lambda Function URL. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `grantInvokeVersion` ```typescript public grantInvokeVersion(grantee: IGrantable, version: IVersion): Grant ``` Grant the given identity permissions to invoke the given version of this Lambda. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `version`^Required - *Type:* aws-cdk-lib.aws_lambda.IVersion --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Function. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricDuration` ```typescript public metricDuration(props?: MetricOptions): Metric ``` How long execution of this Lambda takes. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricErrors` ```typescript public metricErrors(props?: MetricOptions): Metric ``` How many invocations of this Lambda fail. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricInvocations` ```typescript public metricInvocations(props?: MetricOptions): Metric ``` How often this Lambda is invoked. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricThrottles` ```typescript public metricThrottles(props?: MetricOptions): Metric ``` How often this Lambda is throttled. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `addAlias` ```typescript public addAlias(aliasName: string, options?: AliasOptions): Alias ``` Defines an alias for this function. The alias will automatically be updated to point to the latest version of the function as it is being updated during a deployment. ```ts declare const fn: lambda.Function; fn.addAlias('Live'); // Is equivalent to new lambda.Alias(this, 'AliasLive', { aliasName: 'Live', version: fn.currentVersion, }); ``` ###### `aliasName`^Required - *Type:* string The name of the alias. --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_lambda.AliasOptions Alias options. --- ##### `addEnvironment` ```typescript public addEnvironment(key: string, value: string, options?: EnvironmentOptions): Function ``` Adds an environment variable to this Lambda function. If this is a ref to a Lambda function, this operation results in a no-op. ###### `key`^Required - *Type:* string The environment variable key. --- ###### `value`^Required - *Type:* string The environment variable's value. --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_lambda.EnvironmentOptions Environment variable options. --- ##### `addLayers` ```typescript public addLayers(layers: ...ILayerVersion[]): void ``` Adds one or more Lambda Layers to this Lambda function. ###### `layers`^Required - *Type:* ...aws-cdk-lib.aws_lambda.ILayerVersion[] the layers to be added. --- ##### `invalidateVersionBasedOn` ```typescript public invalidateVersionBasedOn(x: string): void ``` Mix additional information into the hash of the Version object. The Lambda Function construct does its best to automatically create a new Version when anything about the Function changes (its code, its layers, any of the other properties). However, you can sometimes source information from places that the CDK cannot look into, like the deploy-time values of SSM parameters. In those cases, the CDK would not force the creation of a new Version object when it actually should. This method can be used to invalidate the current Version object. Pass in any string into this method, and make sure the string changes when you know a new Version needs to be created. This method may be called more than once. ###### `x`^Required - *Type:* string --- ##### `alarmConcurrentExecutions` ```typescript public alarmConcurrentExecutions(props?: LambdaConcurrentExecutionsAlarmConfig): LambdaConcurrentExecutionsAlarm ``` Creates an alarm that monitors the number of concurrent executions. ###### `props`^Optional - *Type:* LambdaConcurrentExecutionsAlarmConfig --- ##### `alarmDuration` ```typescript public alarmDuration(props: LambdaDurationAlarmConfig): LambdaDurationAlarm ``` Creates an alarm that monitors the duration of the function invocations. ###### `props`^Required - *Type:* LambdaDurationAlarmConfig --- ##### `alarmErrors` ```typescript public alarmErrors(props: LambdaErrorsAlarmConfig): LambdaErrorsAlarm ``` Creates an alarm that monitors the number of errors. ###### `props`^Required - *Type:* LambdaErrorsAlarmConfig --- ##### `alarmThrottles` ```typescript public alarmThrottles(props: LambdaThrottlesAlarmConfig): LambdaThrottlesAlarm ``` Creates an alarm that monitors the number of throttles. ###### `props`^Required - *Type:* LambdaThrottlesAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: LambdaRecommendedAlarmsConfig): LambdaRecommendedAlarms ``` Creates recommended alarms for the Lambda function. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#Lambda](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#Lambda) ###### `props`^Required - *Type:* LambdaRecommendedAlarmsConfig --- #### 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. | | classifyVersionProperty | Record whether specific properties in the `AWS::Lambda::Function` resource should also be associated to the Version resource. | | fromFunctionArn | Import a lambda function into the CDK using its ARN. | | fromFunctionAttributes | Creates a Lambda function object which represents a function not defined within this stack. | | fromFunctionName | Import a lambda function into the CDK using its name. | | metricAll | Return the given named metric for this Lambda. | | metricAllConcurrentExecutions | Metric for the number of concurrent executions across all Lambdas. | | metricAllDuration | Metric for the Duration executing all Lambdas. | | metricAllErrors | Metric for the number of Errors executing all Lambdas. | | metricAllInvocations | Metric for the number of invocations of all Lambdas. | | metricAllThrottles | Metric for the number of throttled invocations of all Lambdas. | | metricAllUnreservedConcurrentExecutions | Metric for the number of unreserved concurrent executions across all Lambdas. | --- ##### `isConstruct` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.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 { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `classifyVersionProperty` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.classifyVersionProperty(propertyName: string, locked: boolean) ``` Record whether specific properties in the `AWS::Lambda::Function` resource should also be associated to the Version resource. See 'currentVersion' section in the module README for more details. ###### `propertyName`^Required - *Type:* string The property to classify. --- ###### `locked`^Required - *Type:* boolean whether the property should be associated to the version or not. --- ##### `fromFunctionArn` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.fromFunctionArn(scope: Construct, id: string, functionArn: string) ``` Import a lambda function into the CDK using its ARN. For `Function.addPermissions()` to work on this imported lambda, make sure that is in the same account and region as the stack you are importing it into. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `functionArn`^Required - *Type:* string --- ##### `fromFunctionAttributes` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.fromFunctionAttributes(scope: Construct, id: string, attrs: FunctionAttributes) ``` Creates a Lambda function object which represents a function not defined within this stack. For `Function.addPermissions()` to work on this imported lambda, set the sameEnvironment property to true if this imported lambda is in the same account and region as the stack you are importing it into. ###### `scope`^Required - *Type:* constructs.Construct The parent construct. --- ###### `id`^Required - *Type:* string The name of the lambda construct. --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_lambda.FunctionAttributes the attributes of the function to import. --- ##### `fromFunctionName` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.fromFunctionName(scope: Construct, id: string, functionName: string) ``` Import a lambda function into the CDK using its name. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `functionName`^Required - *Type:* string --- ##### `metricAll` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.metricAll(metricName: string, props?: MetricOptions) ``` Return the given named metric for this Lambda. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllConcurrentExecutions` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.metricAllConcurrentExecutions(props?: MetricOptions) ``` Metric for the number of concurrent executions across all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllDuration` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.metricAllDuration(props?: MetricOptions) ``` Metric for the Duration executing all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllErrors` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.metricAllErrors(props?: MetricOptions) ``` Metric for the number of Errors executing all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllInvocations` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.metricAllInvocations(props?: MetricOptions) ``` Metric for the number of invocations of all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllThrottles` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.metricAllThrottles(props?: MetricOptions) ``` Metric for the number of throttled invocations of all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAllUnreservedConcurrentExecutions` ```typescript import { Function } from '@renovosolutions/cdk-library-cloudwatch-alarms' Function.metricAllUnreservedConcurrentExecutions(props?: MetricOptions) ``` Metric for the number of unreserved concurrent executions across all Lambdas. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | architecture | aws-cdk-lib.aws_lambda.Architecture | The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64). | | connections | aws-cdk-lib.aws_ec2.Connections | Access the Connections object. | | functionArn | string | ARN of this function. | | functionName | string | Name of this function. | | functionRef | aws-cdk-lib.interfaces.aws_lambda.FunctionReference | A reference to a Function resource. | | grantPrincipal | aws-cdk-lib.aws_iam.IPrincipal | The principal this Lambda Function is running as. | | isBoundToVpc | boolean | Whether or not this Lambda function was bound to a VPC. | | latestVersion | aws-cdk-lib.aws_lambda.IVersion | The `$LATEST` version of this function. | | permissionsNode | constructs.Node | The construct node where permissions are attached. | | resourceArnsForGrantInvoke | string[] | The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke(). | | role | aws-cdk-lib.aws_iam.IRole | Execution role associated with this function. | | tenancyConfig | aws-cdk-lib.aws_lambda.TenancyConfig | The tenancy configuration for this function. | | currentVersion | aws-cdk-lib.aws_lambda.Version | Returns a `lambda.Version` which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes. | | logGroup | aws-cdk-lib.aws_logs.ILogGroup | The LogGroup where the Lambda function's logs are made available. | | runtime | aws-cdk-lib.aws_lambda.Runtime | The runtime configured for this lambda. | | deadLetterQueue | aws-cdk-lib.aws_sqs.IQueue | The DLQ (as queue) associated with this Lambda Function (this is an optional attribute). | | deadLetterTopic | aws-cdk-lib.aws_sns.ITopic | The DLQ (as topic) associated with this Lambda Function (this is an optional attribute). | | timeout | aws-cdk-lib.Duration | The timeout configured for this lambda. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `architecture`^Required ```typescript public readonly architecture: Architecture; ``` - *Type:* aws-cdk-lib.aws_lambda.Architecture The architecture of this Lambda Function (this is an optional attribute and defaults to X86_64). --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Access the Connections object. Will fail if not a VPC-enabled Lambda Function --- ##### `functionArn`^Required ```typescript public readonly functionArn: string; ``` - *Type:* string ARN of this function. --- ##### `functionName`^Required ```typescript public readonly functionName: string; ``` - *Type:* string Name of this function. --- ##### `functionRef`^Required ```typescript public readonly functionRef: FunctionReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_lambda.FunctionReference A reference to a Function resource. --- ##### `grantPrincipal`^Required ```typescript public readonly grantPrincipal: IPrincipal; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal this Lambda Function is running as. --- ##### `isBoundToVpc`^Required ```typescript public readonly isBoundToVpc: boolean; ``` - *Type:* boolean Whether or not this Lambda function was bound to a VPC. If this is is `false`, trying to access the `connections` object will fail. --- ##### `latestVersion`^Required ```typescript public readonly latestVersion: IVersion; ``` - *Type:* aws-cdk-lib.aws_lambda.IVersion The `$LATEST` version of this function. Note that this is reference to a non-specific AWS Lambda version, which means the function this version refers to can return different results in different invocations. To obtain a reference to an explicit version which references the current function configuration, use `lambdaFunction.currentVersion` instead. --- ##### `permissionsNode`^Required ```typescript public readonly permissionsNode: Node; ``` - *Type:* constructs.Node The construct node where permissions are attached. --- ##### `resourceArnsForGrantInvoke`^Required ```typescript public readonly resourceArnsForGrantInvoke: string[]; ``` - *Type:* string[] The ARN(s) to put into the resource field of the generated IAM policy for grantInvoke(). --- ##### `role`^Optional ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole Execution role associated with this function. --- ##### `tenancyConfig`^Optional ```typescript public readonly tenancyConfig: TenancyConfig; ``` - *Type:* aws-cdk-lib.aws_lambda.TenancyConfig The tenancy configuration for this function. --- ##### `currentVersion`^Required ```typescript public readonly currentVersion: Version; ``` - *Type:* aws-cdk-lib.aws_lambda.Version Returns a `lambda.Version` which represents the current version of this Lambda function. A new version will be created every time the function's configuration changes. You can specify options for this version using the `currentVersionOptions` prop when initializing the `lambda.Function`. --- ##### `logGroup`^Required ```typescript public readonly logGroup: ILogGroup; ``` - *Type:* aws-cdk-lib.aws_logs.ILogGroup The LogGroup where the Lambda function's logs are made available. If either `logRetention` is set or this property is called, a CloudFormation custom resource is added to the stack that pre-creates the log group as part of the stack deployment, if it already doesn't exist, and sets the correct log retention period (never expire, by default). Further, if the log group already exists and the `logRetention` is not set, the custom resource will reset the log retention to never expire even if it was configured with a different value. --- ##### `runtime`^Required ```typescript public readonly runtime: Runtime; ``` - *Type:* aws-cdk-lib.aws_lambda.Runtime The runtime configured for this lambda. --- ##### `deadLetterQueue`^Optional ```typescript public readonly deadLetterQueue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue The DLQ (as queue) associated with this Lambda Function (this is an optional attribute). --- ##### `deadLetterTopic`^Optional ```typescript public readonly deadLetterTopic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The DLQ (as topic) associated with this Lambda Function (this is an optional attribute). --- ##### `timeout`^Optional ```typescript public readonly timeout: Duration; ``` - *Type:* aws-cdk-lib.Duration The timeout configured for this lambda. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### Instance An extension for the Instance construct that provides methods to create recommended alarms. #### Initializers ```typescript import { Instance } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Instance(scope: Construct, id: string, props: InstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_ec2.InstanceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_ec2.InstanceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addSecurityGroup | Add the security group to the instance. | | addToRolePolicy | Adds a statement to the IAM role assumed by the instance. | | addUserData | Add command to the startup script of the instance. | | applyCloudFormationInit | Use a CloudFormation Init configuration at instance startup. | | alarmCpuUtilization | Creates an alarm that monitors the CPUUtilization for the EC2 instance. | | alarmStatusCheckFailed | Creates an alarm that monitors the StatusCheckFailed for the EC2 instance. | | applyRecommendedAlarms | Creates the recommended alarms for the EC2 Instance. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addSecurityGroup` ```typescript public addSecurityGroup(securityGroup: ISecurityGroup): void ``` Add the security group to the instance. ###### `securityGroup`^Required - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup : The security group to add. --- ##### `addToRolePolicy` ```typescript public addToRolePolicy(statement: PolicyStatement): void ``` Adds a statement to the IAM role assumed by the instance. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement --- ##### `addUserData` ```typescript public addUserData(commands: ...string[]): void ``` Add command to the startup script of the instance. The command must be in the scripting language supported by the instance's OS (i.e. Linux/Windows). ###### `commands`^Required - *Type:* ...string[] --- ##### `applyCloudFormationInit` ```typescript public applyCloudFormationInit(init: CloudFormationInit, options?: ApplyCloudFormationInitOptions): void ``` Use a CloudFormation Init configuration at instance startup. This does the following: - Attaches the CloudFormation Init metadata to the Instance resource. - Add commands to the instance UserData to run `cfn-init` and `cfn-signal`. - Update the instance's CreationPolicy to wait for the `cfn-signal` commands. ###### `init`^Required - *Type:* aws-cdk-lib.aws_ec2.CloudFormationInit --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_ec2.ApplyCloudFormationInitOptions --- ##### `alarmCpuUtilization` ```typescript public alarmCpuUtilization(props?: Ec2CpuUtilizationAlarmConfig): Ec2InstanceCpuUtilizationAlarm ``` Creates an alarm that monitors the CPUUtilization for the EC2 instance. ###### `props`^Optional - *Type:* Ec2CpuUtilizationAlarmConfig --- ##### `alarmStatusCheckFailed` ```typescript public alarmStatusCheckFailed(props?: Ec2StatusCheckFailedAlarmConfig): Ec2InstanceStatusCheckFailedAlarm ``` Creates an alarm that monitors the StatusCheckFailed for the EC2 instance. ###### `props`^Optional - *Type:* Ec2StatusCheckFailedAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props?: Ec2InstanceRecommendedAlarmsConfig): Ec2InstanceRecommendedAlarms ``` Creates the recommended alarms for the EC2 Instance. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EC2](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EC2) ###### `props`^Optional - *Type:* Ec2InstanceRecommendedAlarmsConfig --- #### 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 { Instance } from '@renovosolutions/cdk-library-cloudwatch-alarms' Instance.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 { Instance } from '@renovosolutions/cdk-library-cloudwatch-alarms' Instance.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Instance } from '@renovosolutions/cdk-library-cloudwatch-alarms' Instance.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.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | connections | aws-cdk-lib.aws_ec2.Connections | Allows specify security group connections for the instance. | | grantPrincipal | aws-cdk-lib.aws_iam.IPrincipal | The principal to grant permissions to. | | instance | aws-cdk-lib.aws_ec2.CfnInstance | the underlying instance resource. | | instanceAvailabilityZone | string | The availability zone the instance was launched in. | | instanceId | string | The instance's ID. | | instancePrivateDnsName | string | Private DNS name for this instance. | | instancePrivateIp | string | Private IP for this instance. | | instancePublicDnsName | string | Publicly-routable DNS name for this instance. | | instancePublicIp | string | Publicly-routable IP address for this instance. | | instanceRef | aws-cdk-lib.interfaces.aws_ec2.InstanceReference | A reference to a Instance resource. | | osType | aws-cdk-lib.aws_ec2.OperatingSystemType | The type of OS the instance is running. | | role | aws-cdk-lib.aws_iam.IRole | The IAM role assumed by the instance. | | userData | aws-cdk-lib.aws_ec2.UserData | UserData for the instance. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Allows specify security group connections for the instance. --- ##### `grantPrincipal`^Required ```typescript public readonly grantPrincipal: IPrincipal; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal to grant permissions to. --- ##### `instance`^Required ```typescript public readonly instance: CfnInstance; ``` - *Type:* aws-cdk-lib.aws_ec2.CfnInstance the underlying instance resource. --- ##### `instanceAvailabilityZone`^Required ```typescript public readonly instanceAvailabilityZone: string; ``` - *Type:* string The availability zone the instance was launched in. --- ##### `instanceId`^Required ```typescript public readonly instanceId: string; ``` - *Type:* string The instance's ID. --- ##### `instancePrivateDnsName`^Required ```typescript public readonly instancePrivateDnsName: string; ``` - *Type:* string Private DNS name for this instance. --- ##### `instancePrivateIp`^Required ```typescript public readonly instancePrivateIp: string; ``` - *Type:* string Private IP for this instance. --- ##### `instancePublicDnsName`^Required ```typescript public readonly instancePublicDnsName: string; ``` - *Type:* string Publicly-routable DNS name for this instance. (May be an empty string if the instance does not have a public name). --- ##### `instancePublicIp`^Required ```typescript public readonly instancePublicIp: string; ``` - *Type:* string Publicly-routable IP address for this instance. (May be an empty string if the instance does not have a public IP). --- ##### `instanceRef`^Required ```typescript public readonly instanceRef: InstanceReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_ec2.InstanceReference A reference to a Instance resource. --- ##### `osType`^Required ```typescript public readonly osType: OperatingSystemType; ``` - *Type:* aws-cdk-lib.aws_ec2.OperatingSystemType The type of OS the instance is running. --- ##### `role`^Required ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole The IAM role assumed by the instance. --- ##### `userData`^Required ```typescript public readonly userData: UserData; ``` - *Type:* aws-cdk-lib.aws_ec2.UserData UserData for the instance. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### InterfaceVpcEndpoint An extension for the InterfaceVpcEndpoint construct that provides methods to create recommended alarms. #### Initializers ```typescript import { InterfaceVpcEndpoint } from '@renovosolutions/cdk-library-cloudwatch-alarms' new InterfaceVpcEndpoint(scope: Construct, id: string, props: InterfaceVpcEndpointProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_ec2.InterfaceVpcEndpointProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_ec2.InterfaceVpcEndpointProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addToPolicy | Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal. | | alarmPacketsDropped | Creates an alarm that monitors the PacketsDropped for the PrivateLink endpoint. | | applyRecommendedAlarms | Creates the recommended alarms for the PrivateLink InterfaceVpcEndpoint. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addToPolicy` ```typescript public addToPolicy(statement: PolicyStatement): void ``` Adds a statement to the policy document of the VPC endpoint. The statement must have a Principal. Not all interface VPC endpoints support policy. For more information see https://docs.aws.amazon.com/vpc/latest/userguide/vpce-interface.html ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement the IAM statement to add. --- ##### `alarmPacketsDropped` ```typescript public alarmPacketsDropped(props: PrivateLinkEndpointsPacketsDroppedAlarmConfig): PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm[] ``` Creates an alarm that monitors the PacketsDropped for the PrivateLink endpoint. ###### `props`^Required - *Type:* PrivateLinkEndpointsPacketsDroppedAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig): PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms ``` Creates the recommended alarms for the PrivateLink InterfaceVpcEndpoint. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints) ###### `props`^Required - *Type:* PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig --- #### 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. | | fromInterfaceVpcEndpointAttributes | Imports an existing interface VPC endpoint. | --- ##### `isConstruct` ```typescript import { InterfaceVpcEndpoint } from '@renovosolutions/cdk-library-cloudwatch-alarms' InterfaceVpcEndpoint.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 { InterfaceVpcEndpoint } from '@renovosolutions/cdk-library-cloudwatch-alarms' InterfaceVpcEndpoint.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { InterfaceVpcEndpoint } from '@renovosolutions/cdk-library-cloudwatch-alarms' InterfaceVpcEndpoint.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromInterfaceVpcEndpointAttributes` ```typescript import { InterfaceVpcEndpoint } from '@renovosolutions/cdk-library-cloudwatch-alarms' InterfaceVpcEndpoint.fromInterfaceVpcEndpointAttributes(scope: Construct, id: string, attrs: InterfaceVpcEndpointAttributes) ``` Imports an existing interface VPC endpoint. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_ec2.InterfaceVpcEndpointAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | vpcEndpointId | string | The interface VPC endpoint identifier. | | vpcEndpointRef | aws-cdk-lib.interfaces.aws_ec2.VPCEndpointReference | A reference to a VPCEndpoint resource. | | connections | aws-cdk-lib.aws_ec2.Connections | Access to network connections. | | vpcEndpointCreationTimestamp | string | The date and time the interface VPC endpoint was created. | | vpcEndpointDnsEntries | string[] | The DNS entries for the interface VPC endpoint. | | vpcEndpointNetworkInterfaceIds | string[] | One or more network interfaces for the interface VPC endpoint. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `vpcEndpointId`^Required ```typescript public readonly vpcEndpointId: string; ``` - *Type:* string The interface VPC endpoint identifier. --- ##### `vpcEndpointRef`^Required ```typescript public readonly vpcEndpointRef: VPCEndpointReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_ec2.VPCEndpointReference A reference to a VPCEndpoint resource. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections Access to network connections. --- ##### `vpcEndpointCreationTimestamp`^Required ```typescript public readonly vpcEndpointCreationTimestamp: string; ``` - *Type:* string The date and time the interface VPC endpoint was created. --- ##### `vpcEndpointDnsEntries`^Required ```typescript public readonly vpcEndpointDnsEntries: string[]; ``` - *Type:* string[] The DNS entries for the interface VPC endpoint. Each entry is a combination of the hosted zone ID and the DNS name. The entries are ordered as follows: regional public DNS, zonal public DNS, private DNS, and wildcard DNS. This order is not enforced for AWS Marketplace services. The following is an example. In the first entry, the hosted zone ID is Z1HUB23UULQXV and the DNS name is vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com. ["Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3.ec2.us-east-1.vpce.amazonaws.com", "Z1HUB23UULQXV:vpce-01abc23456de78f9g-12abccd3-us-east-1a.ec2.us-east-1.vpce.amazonaws.com", "Z1C12344VYDITB0:ec2.us-east-1.amazonaws.com"] If you update the PrivateDnsEnabled or SubnetIds properties, the DNS entries in the list will change. --- ##### `vpcEndpointNetworkInterfaceIds`^Required ```typescript public readonly vpcEndpointNetworkInterfaceIds: string[]; ``` - *Type:* string[] One or more network interfaces for the interface VPC endpoint. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### LambdaConcurrentExecutionsAlarm This alarm can proactively detect if the concurrency of the function is approaching the Region-level concurrency quota of your account, so that you can act on it. A function is throttled if it reaches the Region-level concurrency quota of the account. The alarm is triggered when the number of concurrent executions exceeds the specified threshold. #### Initializers ```typescript import { LambdaConcurrentExecutionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new LambdaConcurrentExecutionsAlarm(scope: Construct, id: string, props: LambdaConcurrentExecutionsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | LambdaConcurrentExecutionsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* LambdaConcurrentExecutionsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { LambdaConcurrentExecutionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaConcurrentExecutionsAlarm.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 { LambdaConcurrentExecutionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaConcurrentExecutionsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { LambdaConcurrentExecutionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaConcurrentExecutionsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { LambdaConcurrentExecutionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaConcurrentExecutionsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { LambdaConcurrentExecutionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaConcurrentExecutionsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### LambdaDurationAlarm This alarm can detect a long running duration of a Lambda function. High runtime duration indicates that a function is taking a longer time for invocation, and can also impact the concurrency capacity of invocation if Lambda is handling a higher number of events. It is critical to know if the Lambda function is constantly taking longer execution time than expected. The alarm is triggered when the duration of the function invocations exceeds the specified threshold. #### Initializers ```typescript import { LambdaDurationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new LambdaDurationAlarm(scope: Construct, id: string, props: LambdaDurationAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | LambdaDurationAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* LambdaDurationAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { LambdaDurationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaDurationAlarm.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 { LambdaDurationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaDurationAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { LambdaDurationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaDurationAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { LambdaDurationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaDurationAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { LambdaDurationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaDurationAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### LambdaErrorsAlarm The alarm helps detect high error counts in function invocations. The alarm is triggered when the number of errors exceeds the specified threshold. #### Initializers ```typescript import { LambdaErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new LambdaErrorsAlarm(scope: Construct, id: string, props: LambdaErrorsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | LambdaErrorsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* LambdaErrorsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { LambdaErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaErrorsAlarm.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 { LambdaErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaErrorsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { LambdaErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaErrorsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { LambdaErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaErrorsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { LambdaErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaErrorsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### LambdaRecommendedAlarms A construct that creates recommended alarms for a Lambda function. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#Lambda](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#Lambda) #### Initializers ```typescript import { LambdaRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new LambdaRecommendedAlarms(scope: Construct, id: string, props: LambdaRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | LambdaRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* LambdaRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { LambdaRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaRecommendedAlarms.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. | | alarmConcurrentExecutions | LambdaConcurrentExecutionsAlarm | The concurrent executions alarm for the Lambda function. | | alarmDuration | LambdaDurationAlarm | The duration alarm for the Lambda function. | | alarmErrors | LambdaErrorsAlarm | The error alarm for the Lambda function. | | alarmThrottles | LambdaThrottlesAlarm | The throttles alarm for the Lambda function. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmConcurrentExecutions`^Optional ```typescript public readonly alarmConcurrentExecutions: LambdaConcurrentExecutionsAlarm; ``` - *Type:* LambdaConcurrentExecutionsAlarm The concurrent executions alarm for the Lambda function. --- ##### `alarmDuration`^Optional ```typescript public readonly alarmDuration: LambdaDurationAlarm; ``` - *Type:* LambdaDurationAlarm The duration alarm for the Lambda function. --- ##### `alarmErrors`^Optional ```typescript public readonly alarmErrors: LambdaErrorsAlarm; ``` - *Type:* LambdaErrorsAlarm The error alarm for the Lambda function. --- ##### `alarmThrottles`^Optional ```typescript public readonly alarmThrottles: LambdaThrottlesAlarm; ``` - *Type:* LambdaThrottlesAlarm The throttles alarm for the Lambda function. --- ### LambdaThrottlesAlarm The alarm helps detect a high number of throttled invocation requests for a Lambda function. It is important to know if requests are constantly getting rejected due to throttling and if you need to improve Lambda function performance or increase concurrency capacity to avoid constant throttling. The alarm is triggered when the number of throttles exceeds or equals the specified threshold. #### Initializers ```typescript import { LambdaThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new LambdaThrottlesAlarm(scope: Construct, id: string, props: LambdaThrottlesAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | LambdaThrottlesAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* LambdaThrottlesAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { LambdaThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaThrottlesAlarm.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 { LambdaThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaThrottlesAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { LambdaThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaThrottlesAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { LambdaThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaThrottlesAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { LambdaThrottlesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' LambdaThrottlesAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### NetworkLoadBalancer An extension for the NetworkLoadBalancer construct that provides methods to create recommended alarms. #### Initializers ```typescript import { NetworkLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkLoadBalancer(scope: Construct, id: string, props: NetworkLoadBalancerProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancerProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancerProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | logAccessLogs | Enable access logging for this load balancer. | | removeAttribute | Remove an attribute from the load balancer. | | setAttribute | Set a non-standard attribute on the load balancer. | | addListener | Add a listener to this load balancer. | | addSecurityGroup | Add a security group to this load balancer. | | metric | Return the given named metric for this Network Load Balancer. | | metricActiveFlowCount | The total number of concurrent TCP flows (or connections) from clients to targets. | | metricConsumedLCUs | The number of load balancer capacity units (LCU) used by your load balancer. | | metricNewFlowCount | The total number of new TCP flows (or connections) established from clients to targets in the time period. | | metricProcessedBytes | The total number of bytes processed by the load balancer, including TCP/IP headers. | | metricTcpClientResetCount | The total number of reset (RST) packets sent from a client to a target. | | metricTcpElbResetCount | The total number of reset (RST) packets generated by the load balancer. | | metricTcpTargetResetCount | The total number of reset (RST) packets sent from a target to a client. | | alarmTcpElbResetCount | Creates an alarm that monitors the TCP reset count from the load balancer. | | alarmTcpTargetResetCount | Creates an alarm that monitors the TCP reset count from targets. | | applyRecommendedAlarms | Creates the recommended alarms for the NetworkLoadBalancer. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `logAccessLogs` ```typescript public logAccessLogs(bucket: IBucket, prefix?: string): void ``` Enable access logging for this load balancer. A region must be specified on the stack containing the load balancer; you cannot enable logging on environment-agnostic stacks. See https://docs.aws.amazon.com/cdk/latest/guide/environments.html ###### `bucket`^Required - *Type:* aws-cdk-lib.aws_s3.IBucket --- ###### `prefix`^Optional - *Type:* string --- ##### `removeAttribute` ```typescript public removeAttribute(key: string): void ``` Remove an attribute from the load balancer. ###### `key`^Required - *Type:* string --- ##### `setAttribute` ```typescript public setAttribute(key: string, value?: string): void ``` Set a non-standard attribute on the load balancer. > [https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#load-balancer-attributes) ###### `key`^Required - *Type:* string --- ###### `value`^Optional - *Type:* string --- ##### `addListener` ```typescript public addListener(id: string, props: BaseNetworkListenerProps): NetworkListener ``` Add a listener to this load balancer. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.BaseNetworkListenerProps --- ##### `addSecurityGroup` ```typescript public addSecurityGroup(securityGroup: ISecurityGroup): void ``` Add a security group to this load balancer. ###### `securityGroup`^Required - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup --- ##### ~~`metric`~~ ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Network Load Balancer. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricActiveFlowCount`~~ ```typescript public metricActiveFlowCount(props?: MetricOptions): Metric ``` The total number of concurrent TCP flows (or connections) from clients to targets. This metric includes connections in the SYN_SENT and ESTABLISHED states. TCP connections are not terminated at the load balancer, so a client opening a TCP connection to a target counts as a single flow. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricConsumedLCUs`~~ ```typescript public metricConsumedLCUs(props?: MetricOptions): Metric ``` The number of load balancer capacity units (LCU) used by your load balancer. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricNewFlowCount`~~ ```typescript public metricNewFlowCount(props?: MetricOptions): Metric ``` The total number of new TCP flows (or connections) established from clients to targets in the time period. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricProcessedBytes`~~ ```typescript public metricProcessedBytes(props?: MetricOptions): Metric ``` The total number of bytes processed by the load balancer, including TCP/IP headers. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricTcpClientResetCount`~~ ```typescript public metricTcpClientResetCount(props?: MetricOptions): Metric ``` The total number of reset (RST) packets sent from a client to a target. These resets are generated by the client and forwarded by the load balancer. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricTcpElbResetCount`~~ ```typescript public metricTcpElbResetCount(props?: MetricOptions): Metric ``` The total number of reset (RST) packets generated by the load balancer. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricTcpTargetResetCount`~~ ```typescript public metricTcpTargetResetCount(props?: MetricOptions): Metric ``` The total number of reset (RST) packets sent from a target to a client. These resets are generated by the target and forwarded by the load balancer. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `alarmTcpElbResetCount` ```typescript public alarmTcpElbResetCount(props?: NetworkLoadBalancerTcpElbResetCountAlarmConfig): NetworkLoadBalancerTcpElbResetCountAlarm ``` Creates an alarm that monitors the TCP reset count from the load balancer. ###### `props`^Optional - *Type:* NetworkLoadBalancerTcpElbResetCountAlarmConfig --- ##### `alarmTcpTargetResetCount` ```typescript public alarmTcpTargetResetCount(props?: NetworkLoadBalancerTcpTargetResetCountAlarmConfig): NetworkLoadBalancerTcpTargetResetCountAlarm ``` Creates an alarm that monitors the TCP reset count from targets. ###### `props`^Optional - *Type:* NetworkLoadBalancerTcpTargetResetCountAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: NetworkLoadBalancerRecommendedAlarmsConfig): NetworkLoadBalancerRecommendedAlarms ``` Creates the recommended alarms for the NetworkLoadBalancer. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) ###### `props`^Required - *Type:* NetworkLoadBalancerRecommendedAlarmsConfig --- #### 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. | | fromLookup | Looks up the network load balancer. | | fromNetworkLoadBalancerAttributes | *No description.* | --- ##### `isConstruct` ```typescript import { NetworkLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancer.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 { NetworkLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancer.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { NetworkLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancer.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromLookup` ```typescript import { NetworkLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancer.fromLookup(scope: Construct, id: string, options: NetworkLoadBalancerLookupOptions) ``` Looks up the network load balancer. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancerLookupOptions --- ##### `fromNetworkLoadBalancerAttributes` ```typescript import { NetworkLoadBalancer } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancer.fromNetworkLoadBalancerAttributes(scope: Construct, id: string, attrs: NetworkLoadBalancerAttributes) ``` ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancerAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | loadBalancerArn | string | The ARN of this load balancer. | | loadBalancerCanonicalHostedZoneId | string | The canonical hosted zone ID of this load balancer. | | loadBalancerDnsName | string | The DNS name of this load balancer. | | loadBalancerFullName | string | The full name of this load balancer. | | loadBalancerName | string | The name of this load balancer. | | loadBalancerRef | aws-cdk-lib.interfaces.aws_elasticloadbalancingv2.LoadBalancerReference | A reference to this load balancer. | | loadBalancerSecurityGroups | string[] | *No description.* | | vpc | aws-cdk-lib.aws_ec2.IVpc | The VPC this load balancer has been created in. | | connections | aws-cdk-lib.aws_ec2.Connections | The network connections associated with this resource. | | metrics | aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancerMetrics | All metrics available for this load balancer. | | enforceSecurityGroupInboundRulesOnPrivateLinkTraffic | string | Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink. | | ipAddressType | aws-cdk-lib.aws_elasticloadbalancingv2.IpAddressType | The type of IP addresses to use. | | securityGroups | string[] | After the implementation of `IConnectable` (see https://github.com/aws/aws-cdk/pull/28494), the default value for `securityGroups` is set by the `ec2.Connections` constructor to an empty array. To keep backward compatibility (`securityGroups` is `undefined` if the related property is not specified) a getter has been added. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `loadBalancerArn`^Required ```typescript public readonly loadBalancerArn: string; ``` - *Type:* string The ARN of this load balancer. Example value: `arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/50dc6c495c0c9188` --- ##### `loadBalancerCanonicalHostedZoneId`^Required ```typescript public readonly loadBalancerCanonicalHostedZoneId: string; ``` - *Type:* string The canonical hosted zone ID of this load balancer. Example value: `Z2P70J7EXAMPLE` --- ##### `loadBalancerDnsName`^Required ```typescript public readonly loadBalancerDnsName: string; ``` - *Type:* string The DNS name of this load balancer. Example value: `my-load-balancer-424835706.us-west-2.elb.amazonaws.com` --- ##### `loadBalancerFullName`^Required ```typescript public readonly loadBalancerFullName: string; ``` - *Type:* string The full name of this load balancer. Example value: `app/my-load-balancer/50dc6c495c0c9188` --- ##### `loadBalancerName`^Required ```typescript public readonly loadBalancerName: string; ``` - *Type:* string The name of this load balancer. Example value: `my-load-balancer` --- ##### `loadBalancerRef`^Required ```typescript public readonly loadBalancerRef: LoadBalancerReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_elasticloadbalancingv2.LoadBalancerReference A reference to this load balancer. --- ##### `loadBalancerSecurityGroups`^Required ```typescript public readonly loadBalancerSecurityGroups: string[]; ``` - *Type:* string[] --- ##### `vpc`^Optional ```typescript public readonly vpc: IVpc; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpc The VPC this load balancer has been created in. This property is always defined (not `null` or `undefined`) for sub-classes of `BaseLoadBalancer`. --- ##### `connections`^Required ```typescript public readonly connections: Connections; ``` - *Type:* aws-cdk-lib.aws_ec2.Connections The network connections associated with this resource. --- ##### `metrics`^Required ```typescript public readonly metrics: INetworkLoadBalancerMetrics; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancerMetrics All metrics available for this load balancer. --- ##### `enforceSecurityGroupInboundRulesOnPrivateLinkTraffic`^Optional ```typescript public readonly enforceSecurityGroupInboundRulesOnPrivateLinkTraffic: string; ``` - *Type:* string Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through AWS PrivateLink. --- ##### `ipAddressType`^Optional ```typescript public readonly ipAddressType: IpAddressType; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.IpAddressType The type of IP addresses to use. --- ##### `securityGroups`^Optional ```typescript public readonly securityGroups: string[]; ``` - *Type:* string[] After the implementation of `IConnectable` (see https://github.com/aws/aws-cdk/pull/28494), the default value for `securityGroups` is set by the `ec2.Connections` constructor to an empty array. To keep backward compatibility (`securityGroups` is `undefined` if the related property is not specified) a getter has been added. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### NetworkLoadBalancerRecommendedAlarms A construct that creates the recommended alarms for a NetworkLoadBalancer. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) #### Initializers ```typescript import { NetworkLoadBalancerRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkLoadBalancerRecommendedAlarms(scope: Construct, id: string, props: NetworkLoadBalancerRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NetworkLoadBalancerRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NetworkLoadBalancerRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NetworkLoadBalancerRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerRecommendedAlarms.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. | | alarmTcpElbResetCount | NetworkLoadBalancerTcpElbResetCountAlarm | The TcpElbResetCount alarm. | | alarmTcpTargetResetCount | NetworkLoadBalancerTcpTargetResetCountAlarm | The TcpTargetResetCount alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmTcpElbResetCount`^Optional ```typescript public readonly alarmTcpElbResetCount: NetworkLoadBalancerTcpElbResetCountAlarm; ``` - *Type:* NetworkLoadBalancerTcpElbResetCountAlarm The TcpElbResetCount alarm. --- ##### `alarmTcpTargetResetCount`^Optional ```typescript public readonly alarmTcpTargetResetCount: NetworkLoadBalancerTcpTargetResetCountAlarm; ``` - *Type:* NetworkLoadBalancerTcpTargetResetCountAlarm The TcpTargetResetCount alarm. --- ### NetworkLoadBalancerTcpElbResetCountAlarm This alarm is used to detect when the load balancer is sending TCP reset packets. A high number of resets can indicate connectivity issues between the load balancer and clients. The alarm is triggered when the number of TCP resets from the load balancer is greater than threshold. #### Initializers ```typescript import { NetworkLoadBalancerTcpElbResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkLoadBalancerTcpElbResetCountAlarm(scope: IConstruct, id: string, props: NetworkLoadBalancerTcpElbResetCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | NetworkLoadBalancerTcpElbResetCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NetworkLoadBalancerTcpElbResetCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { NetworkLoadBalancerTcpElbResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpElbResetCountAlarm.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 { NetworkLoadBalancerTcpElbResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpElbResetCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { NetworkLoadBalancerTcpElbResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpElbResetCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { NetworkLoadBalancerTcpElbResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpElbResetCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { NetworkLoadBalancerTcpElbResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpElbResetCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### NetworkLoadBalancerTcpTargetResetCountAlarm This alarm is used to detect when the targets are sending TCP reset packets. A high number of resets can indicate connectivity issues between the load balancer and targets. The alarm is triggered when the number of TCP resets from targets is greater than threshold. #### Initializers ```typescript import { NetworkLoadBalancerTcpTargetResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkLoadBalancerTcpTargetResetCountAlarm(scope: IConstruct, id: string, props: NetworkLoadBalancerTcpTargetResetCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | NetworkLoadBalancerTcpTargetResetCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NetworkLoadBalancerTcpTargetResetCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { NetworkLoadBalancerTcpTargetResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpTargetResetCountAlarm.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 { NetworkLoadBalancerTcpTargetResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpTargetResetCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { NetworkLoadBalancerTcpTargetResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpTargetResetCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { NetworkLoadBalancerTcpTargetResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpTargetResetCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { NetworkLoadBalancerTcpTargetResetCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkLoadBalancerTcpTargetResetCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### NetworkTargetGroup An extension for the NetworkTargetGroup construct that provides methods to create recommended alarms. #### Initializers ```typescript import { NetworkTargetGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkTargetGroup(scope: Construct, id: string, props: NetworkTargetGroupProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroupProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroupProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | configureHealthCheck | Set/replace the target group's health check. | | setAttribute | Set a non-standard attribute on the target group. | | addTarget | Add a load balancing target to this target group. | | metricHealthyHostCount | The number of targets that are considered healthy. | | metricUnHealthyHostCount | The number of targets that are considered unhealthy. | | registerListener | Register a listener that is load balancing to this target group. | | alarmHealthyHostCount | Creates an alarm that monitors the healthy host count for the NetworkTargetGroup. | | alarmUnHealthyHostCount | Creates an alarm that monitors the unhealthy host count for the NetworkTargetGroup. | | applyRecommendedAlarms | Creates the recommended alarms for the NetworkTargetGroup. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `configureHealthCheck` ```typescript public configureHealthCheck(healthCheck: HealthCheck): void ``` Set/replace the target group's health check. ###### `healthCheck`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.HealthCheck --- ##### `setAttribute` ```typescript public setAttribute(key: string, value?: string): void ``` Set a non-standard attribute on the target group. > [https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html#target-group-attributes) ###### `key`^Required - *Type:* string --- ###### `value`^Optional - *Type:* string --- ##### `addTarget` ```typescript public addTarget(targets: ...INetworkLoadBalancerTarget[]): void ``` Add a load balancing target to this target group. ###### `targets`^Required - *Type:* ...aws-cdk-lib.aws_elasticloadbalancingv2.INetworkLoadBalancerTarget[] --- ##### ~~`metricHealthyHostCount`~~ ```typescript public metricHealthyHostCount(props?: MetricOptions): Metric ``` The number of targets that are considered healthy. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricUnHealthyHostCount`~~ ```typescript public metricUnHealthyHostCount(props?: MetricOptions): Metric ``` The number of targets that are considered unhealthy. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `registerListener` ```typescript public registerListener(listener: INetworkListenerRef): void ``` Register a listener that is load balancing to this target group. Don't call this directly. It will be called by listeners. ###### `listener`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.INetworkListenerRef --- ##### `alarmHealthyHostCount` ```typescript public alarmHealthyHostCount(props?: NetworkTargetGroupHealthyHostCountAlarmConfig): NetworkTargetGroupHealthyHostCountAlarm ``` Creates an alarm that monitors the healthy host count for the NetworkTargetGroup. ###### `props`^Optional - *Type:* NetworkTargetGroupHealthyHostCountAlarmConfig --- ##### `alarmUnHealthyHostCount` ```typescript public alarmUnHealthyHostCount(props?: NetworkTargetGroupUnHealthyHostCountAlarmConfig): NetworkTargetGroupUnHealthyHostCountAlarm ``` Creates an alarm that monitors the unhealthy host count for the NetworkTargetGroup. ###### `props`^Optional - *Type:* NetworkTargetGroupUnHealthyHostCountAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: NetworkTargetGroupRecommendedAlarmsConfig): NetworkTargetGroupRecommendedAlarms ``` Creates the recommended alarms for the NetworkTargetGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) ###### `props`^Required - *Type:* NetworkTargetGroupRecommendedAlarmsConfig --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | fromTargetGroupAttributes | Import an existing target group. | --- ##### `isConstruct` ```typescript import { NetworkTargetGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroup.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. --- ##### `fromTargetGroupAttributes` ```typescript import { NetworkTargetGroup } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroup.fromTargetGroupAttributes(scope: Construct, id: string, attrs: TargetGroupAttributes) ``` Import an existing target group. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.TargetGroupAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | firstLoadBalancerFullName | string | Full name of first load balancer. | | loadBalancerArns | string | A token representing a list of ARNs of the load balancers that route traffic to this target group. | | loadBalancerAttached | constructs.IDependable | List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer. | | targetGroupArn | string | The ARN of the target group. | | targetGroupFullName | string | The full name of the target group. | | targetGroupLoadBalancerArns | string[] | ARNs of load balancers load balancing to this TargetGroup. | | targetGroupName | string | The name of the target group. | | targetGroupRef | aws-cdk-lib.interfaces.aws_elasticloadbalancingv2.TargetGroupReference | A reference to this target group. | | healthCheck | aws-cdk-lib.aws_elasticloadbalancingv2.HealthCheck | Health check for the members of this target group. | | isNetworkTargetGroup | boolean | Indicates that this is a Network Target Group. | | metrics | aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroupMetrics | All metrics available for this target group. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. --- ##### `firstLoadBalancerFullName`^Required ```typescript public readonly firstLoadBalancerFullName: string; ``` - *Type:* string Full name of first load balancer. --- ##### `loadBalancerArns`^Required ```typescript public readonly loadBalancerArns: string; ``` - *Type:* string A token representing a list of ARNs of the load balancers that route traffic to this target group. --- ##### `loadBalancerAttached`^Required ```typescript public readonly loadBalancerAttached: IDependable; ``` - *Type:* constructs.IDependable List of constructs that need to be depended on to ensure the TargetGroup is associated to a load balancer. --- ##### `targetGroupArn`^Required ```typescript public readonly targetGroupArn: string; ``` - *Type:* string The ARN of the target group. --- ##### `targetGroupFullName`^Required ```typescript public readonly targetGroupFullName: string; ``` - *Type:* string The full name of the target group. --- ##### `targetGroupLoadBalancerArns`^Required ```typescript public readonly targetGroupLoadBalancerArns: string[]; ``` - *Type:* string[] ARNs of load balancers load balancing to this TargetGroup. --- ##### `targetGroupName`^Required ```typescript public readonly targetGroupName: string; ``` - *Type:* string The name of the target group. --- ##### `targetGroupRef`^Required ```typescript public readonly targetGroupRef: TargetGroupReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_elasticloadbalancingv2.TargetGroupReference A reference to this target group. --- ##### `healthCheck`^Required ```typescript public readonly healthCheck: HealthCheck; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.HealthCheck Health check for the members of this target group. --- ##### `isNetworkTargetGroup`^Required ```typescript public readonly isNetworkTargetGroup: boolean; ``` - *Type:* boolean Indicates that this is a Network Target Group. Will always return true, but is necessary to prevent accidental structural equality in TypeScript. --- ##### `metrics`^Required ```typescript public readonly metrics: INetworkTargetGroupMetrics; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.INetworkTargetGroupMetrics All metrics available for this target group. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### NetworkTargetGroupHealthyHostCountAlarm This alarm is used to detect when the number of healthy hosts in the target group falls below the threshold. A low number of healthy hosts can indicate service availability issues. #### Initializers ```typescript import { NetworkTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkTargetGroupHealthyHostCountAlarm(scope: IConstruct, id: string, props: NetworkTargetGroupHealthyHostCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | NetworkTargetGroupHealthyHostCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NetworkTargetGroupHealthyHostCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { NetworkTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupHealthyHostCountAlarm.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 { NetworkTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupHealthyHostCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { NetworkTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupHealthyHostCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { NetworkTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupHealthyHostCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { NetworkTargetGroupHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupHealthyHostCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### NetworkTargetGroupRecommendedAlarms A construct that creates the recommended alarms for a NetworkTargetGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) #### Initializers ```typescript import { NetworkTargetGroupRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkTargetGroupRecommendedAlarms(scope: Construct, id: string, props: NetworkTargetGroupRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | NetworkTargetGroupRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NetworkTargetGroupRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { NetworkTargetGroupRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupRecommendedAlarms.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. | | alarmHealthyHostCount | NetworkTargetGroupHealthyHostCountAlarm | The HealthyHostCount alarm. | | alarmUnHealthyHostCount | NetworkTargetGroupUnHealthyHostCountAlarm | The UnHealthyHostCount alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmHealthyHostCount`^Optional ```typescript public readonly alarmHealthyHostCount: NetworkTargetGroupHealthyHostCountAlarm; ``` - *Type:* NetworkTargetGroupHealthyHostCountAlarm The HealthyHostCount alarm. --- ##### `alarmUnHealthyHostCount`^Optional ```typescript public readonly alarmUnHealthyHostCount: NetworkTargetGroupUnHealthyHostCountAlarm; ``` - *Type:* NetworkTargetGroupUnHealthyHostCountAlarm The UnHealthyHostCount alarm. --- ### NetworkTargetGroupUnHealthyHostCountAlarm This alarm is used to detect when the number of unhealthy hosts in the target group exceeds the threshold. A high number of unhealthy hosts can indicate service health issues. #### Initializers ```typescript import { NetworkTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkTargetGroupUnHealthyHostCountAlarm(scope: IConstruct, id: string, props: NetworkTargetGroupUnHealthyHostCountAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | NetworkTargetGroupUnHealthyHostCountAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* NetworkTargetGroupUnHealthyHostCountAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { NetworkTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupUnHealthyHostCountAlarm.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 { NetworkTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupUnHealthyHostCountAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { NetworkTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupUnHealthyHostCountAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { NetworkTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupUnHealthyHostCountAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { NetworkTargetGroupUnHealthyHostCountAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' NetworkTargetGroupUnHealthyHostCountAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm This alarm helps to detect if the endpoint or endpoint service is unhealthy by monitoring the number of packets dropped by the endpoint. Note that packets larger than 8500 bytes that arrive at the VPC endpoint are dropped. For troubleshooting, see connectivity problems between an interface VPC endpoint and an endpoint service. The alarm is triggered when the number of packets dropped exceeds the threshold. #### Initializers ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm(scope: IConstruct, id: string, props: PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm.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 { PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms A construct that creates the recommended alarms for an PrivateLink InterfaceVpcEndpoint. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkEndpoints) #### Initializers ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms(scope: Construct, id: string, props: PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms.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. | | alarmPacketsDroppedList | PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm[] | The PacketsDropped alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmPacketsDroppedList`^Optional ```typescript public readonly alarmPacketsDroppedList: PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm[]; ``` - *Type:* PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm[] The PacketsDropped alarm. --- ### PrivateLinkServicesVpcEndpointServiceRecommendedAlarms A construct that creates the recommended alarms for an PrivateLink VpcEndpointService. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkServices](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkServices) #### Initializers ```typescript import { PrivateLinkServicesVpcEndpointServiceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new PrivateLinkServicesVpcEndpointServiceRecommendedAlarms(scope: Construct, id: string, props: PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { PrivateLinkServicesVpcEndpointServiceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkServicesVpcEndpointServiceRecommendedAlarms.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. | | alarmRstPacketsSentList | PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm[] | The RstPacketsSent alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmRstPacketsSentList`^Optional ```typescript public readonly alarmRstPacketsSentList: PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm[]; ``` - *Type:* PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm[] The RstPacketsSent alarm. --- ### PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm This alarm helps you detect unhealthy targets of an endpoint service based on the number of reset packets that are sent to endpoints. When you debug connection errors with a consumer of your service, you can validate whether the service is resetting connections with the RstPacketsSent metric, or if something else is failing on the network path. The alarm is triggered when the the number of reset packets exceeds the threshold. #### Initializers ```typescript import { PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm(scope: IConstruct, id: string, props: PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm.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 { PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### Queue An extension of the SQS Queue construct that adds methods to create recommended alarms. #### Initializers ```typescript import { Queue } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Queue(scope: Construct, id: string, props?: QueueProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_sqs.QueueProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* aws-cdk-lib.aws_sqs.QueueProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addToResourcePolicy | Adds a statement to the IAM resource policy associated with this queue. | | grant | Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource. | | grantConsumeMessages | Grant permissions to consume messages from a queue. | | grantOnKey | Gives permissions to a grantable entity to perform actions on the encryption key. | | grantPurge | Grant an IAM principal permissions to purge all messages from the queue. | | grantSendMessages | Grant access to send messages to a queue to the given identity. | | metric | Return the given named metric for this Queue. | | metricApproximateAgeOfOldestMessage | The approximate age of the oldest non-deleted message in the queue. | | metricApproximateNumberOfMessagesDelayed | The number of messages in the queue that are delayed and not available for reading immediately. | | metricApproximateNumberOfMessagesNotVisible | The number of messages that are in flight. | | metricApproximateNumberOfMessagesVisible | The number of messages available for retrieval from the queue. | | metricNumberOfEmptyReceives | The number of ReceiveMessage API calls that did not return a message. | | metricNumberOfMessagesDeleted | The number of messages deleted from the queue. | | metricNumberOfMessagesReceived | The number of messages returned by calls to the ReceiveMessage action. | | metricNumberOfMessagesSent | The number of messages added to a queue. | | metricSentMessageSize | The size of messages added to a queue. | | alarmApproximateAgeOfOldestMessage | Creates an alarm that watches the age of the oldest message in the queue. | | alarmApproximateNumberOfMessagesNotVisible | Creates an alarm that watches the number of messages that are in flight. | | alarmApproximateNumberOfMessagesVisible | Creates an alarm that watches the number of messages that are visible in the queue. | | alarmNumberOfMessagesSent | Creates an alarm that watches the number of messages that are sent. | | applyRecommendedAlarms | Creates the recommended alarms for an SQS queue. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the IAM resource policy associated with this queue. If this queue was created in this stack (`new Queue`), a queue policy will be automatically created upon the first call to `addToPolicy`. If the queue is imported (`Queue.import`), then this is a no-op. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Grant the actions defined in queueActions to the identity Principal given on this SQS queue resource. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable Principal to grant right to. --- ###### `actions`^Required - *Type:* ...string[] The actions to grant. --- ##### `grantConsumeMessages` ```typescript public grantConsumeMessages(grantee: IGrantable): Grant ``` Grant permissions to consume messages from a queue. This will grant the following permissions: - sqs:ChangeMessageVisibility - sqs:DeleteMessage - sqs:ReceiveMessage - sqs:GetQueueAttributes - sqs:GetQueueUrl If encryption is used, permission to use the key to decrypt the contents of the queue will also be granted to the same principal. This will grant the following KMS permissions: - kms:Decrypt The use of this method is discouraged. Please use `grants.consumeMessages()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable Principal to grant consume rights to. --- ##### `grantOnKey` ```typescript public grantOnKey(grantee: IGrantable, actions: ...string[]): GrantOnKeyResult ``` Gives permissions to a grantable entity to perform actions on the encryption key. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `actions`^Required - *Type:* ...string[] --- ##### `grantPurge` ```typescript public grantPurge(grantee: IGrantable): Grant ``` Grant an IAM principal permissions to purge all messages from the queue. This will grant the following permissions: - sqs:PurgeQueue - sqs:GetQueueAttributes - sqs:GetQueueUrl The use of this method is discouraged. Please use `grants.purge()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable Principal to grant send rights to. --- ##### `grantSendMessages` ```typescript public grantSendMessages(grantee: IGrantable): Grant ``` Grant access to send messages to a queue to the given identity. This will grant the following permissions: - sqs:SendMessage - sqs:GetQueueAttributes - sqs:GetQueueUrl If encryption is used, permission to use the key to encrypt/decrypt the contents of the queue will also be granted to the same principal. This will grant the following KMS permissions: - kms:Decrypt - kms:Encrypt - kms:ReEncrypt* - kms:GenerateDataKey* The use of this method is discouraged. Please use `grants.sendMessages()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable Principal to grant send rights to. --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Queue. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricApproximateAgeOfOldestMessage` ```typescript public metricApproximateAgeOfOldestMessage(props?: MetricOptions): Metric ``` The approximate age of the oldest non-deleted message in the queue. Maximum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricApproximateNumberOfMessagesDelayed` ```typescript public metricApproximateNumberOfMessagesDelayed(props?: MetricOptions): Metric ``` The number of messages in the queue that are delayed and not available for reading immediately. Maximum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricApproximateNumberOfMessagesNotVisible` ```typescript public metricApproximateNumberOfMessagesNotVisible(props?: MetricOptions): Metric ``` The number of messages that are in flight. Maximum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricApproximateNumberOfMessagesVisible` ```typescript public metricApproximateNumberOfMessagesVisible(props?: MetricOptions): Metric ``` The number of messages available for retrieval from the queue. Maximum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfEmptyReceives` ```typescript public metricNumberOfEmptyReceives(props?: MetricOptions): Metric ``` The number of ReceiveMessage API calls that did not return a message. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfMessagesDeleted` ```typescript public metricNumberOfMessagesDeleted(props?: MetricOptions): Metric ``` The number of messages deleted from the queue. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfMessagesReceived` ```typescript public metricNumberOfMessagesReceived(props?: MetricOptions): Metric ``` The number of messages returned by calls to the ReceiveMessage action. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfMessagesSent` ```typescript public metricNumberOfMessagesSent(props?: MetricOptions): Metric ``` The number of messages added to a queue. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSentMessageSize` ```typescript public metricSentMessageSize(props?: MetricOptions): Metric ``` The size of messages added to a queue. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `alarmApproximateAgeOfOldestMessage` ```typescript public alarmApproximateAgeOfOldestMessage(props: SqsApproximateAgeOfOldestMessageAlarmConfig): SqsApproximateAgeOfOldestMessageAlarm ``` Creates an alarm that watches the age of the oldest message in the queue. ###### `props`^Required - *Type:* SqsApproximateAgeOfOldestMessageAlarmConfig --- ##### `alarmApproximateNumberOfMessagesNotVisible` ```typescript public alarmApproximateNumberOfMessagesNotVisible(props: SqsApproximateNumberOfMessagesNotVisibleAlarmConfig): SqsApproximateNumberOfMessagesNotVisibleAlarm ``` Creates an alarm that watches the number of messages that are in flight. ###### `props`^Required - *Type:* SqsApproximateNumberOfMessagesNotVisibleAlarmConfig --- ##### `alarmApproximateNumberOfMessagesVisible` ```typescript public alarmApproximateNumberOfMessagesVisible(props: SqsApproximateNumberOfMessagesVisibleAlarmConfig): SqsApproximateNumberOfMessagesVisibleAlarm ``` Creates an alarm that watches the number of messages that are visible in the queue. ###### `props`^Required - *Type:* SqsApproximateNumberOfMessagesVisibleAlarmConfig --- ##### `alarmNumberOfMessagesSent` ```typescript public alarmNumberOfMessagesSent(props?: SqsNumberOfMessagesSentAlarmConfig): SqsNumberOfMessagesSentAlarm ``` Creates an alarm that watches the number of messages that are sent. ###### `props`^Optional - *Type:* SqsNumberOfMessagesSentAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: SqsRecommendedAlarmsConfig): void ``` Creates the recommended alarms for an SQS queue. ###### `props`^Required - *Type:* SqsRecommendedAlarmsConfig --- #### 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. | | fromQueueArn | Import an existing SQS queue provided an ARN. | | fromQueueAttributes | Import an existing queue. | --- ##### `isConstruct` ```typescript import { Queue } from '@renovosolutions/cdk-library-cloudwatch-alarms' Queue.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 { Queue } from '@renovosolutions/cdk-library-cloudwatch-alarms' Queue.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Queue } from '@renovosolutions/cdk-library-cloudwatch-alarms' Queue.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromQueueArn` ```typescript import { Queue } from '@renovosolutions/cdk-library-cloudwatch-alarms' Queue.fromQueueArn(scope: Construct, id: string, queueArn: string) ``` Import an existing SQS queue provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct. --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `queueArn`^Required - *Type:* string queue ARN (i.e. arn:aws:sqs:us-east-2:444455556666:queue1). --- ##### `fromQueueAttributes` ```typescript import { Queue } from '@renovosolutions/cdk-library-cloudwatch-alarms' Queue.fromQueueAttributes(scope: Construct, id: string, attrs: QueueAttributes) ``` Import an existing queue. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_sqs.QueueAttributes --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | fifo | boolean | Whether this queue is an Amazon SQS FIFO queue. | | grants | aws-cdk-lib.aws_sqs.QueueGrants | Collection of grant methods for a Queue. | | queueArn | string | The ARN of this queue. | | queueName | string | The name of this queue. | | queueRef | aws-cdk-lib.interfaces.aws_sqs.QueueReference | A reference to a Queue resource. | | queueUrl | string | The URL of this queue. | | encryptionMasterKey | aws-cdk-lib.aws_kms.IKey | If this queue is encrypted, this is the KMS key. | | encryptionType | aws-cdk-lib.aws_sqs.QueueEncryption | Whether the contents of the queue are encrypted, and by what type of key. | | deadLetterQueue | aws-cdk-lib.aws_sqs.DeadLetterQueue | If this queue is configured with a dead-letter queue, this is the dead-letter queue settings. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `fifo`^Required ```typescript public readonly fifo: boolean; ``` - *Type:* boolean Whether this queue is an Amazon SQS FIFO queue. If false, this is a standard queue. --- ##### `grants`^Required ```typescript public readonly grants: QueueGrants; ``` - *Type:* aws-cdk-lib.aws_sqs.QueueGrants Collection of grant methods for a Queue. --- ##### `queueArn`^Required ```typescript public readonly queueArn: string; ``` - *Type:* string The ARN of this queue. --- ##### `queueName`^Required ```typescript public readonly queueName: string; ``` - *Type:* string The name of this queue. --- ##### `queueRef`^Required ```typescript public readonly queueRef: QueueReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_sqs.QueueReference A reference to a Queue resource. --- ##### `queueUrl`^Required ```typescript public readonly queueUrl: string; ``` - *Type:* string The URL of this queue. --- ##### `encryptionMasterKey`^Optional ```typescript public readonly encryptionMasterKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey If this queue is encrypted, this is the KMS key. --- ##### `encryptionType`^Optional ```typescript public readonly encryptionType: QueueEncryption; ``` - *Type:* aws-cdk-lib.aws_sqs.QueueEncryption Whether the contents of the queue are encrypted, and by what type of key. --- ##### `deadLetterQueue`^Optional ```typescript public readonly deadLetterQueue: DeadLetterQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.DeadLetterQueue If this queue is configured with a dead-letter queue, this is the dead-letter queue settings. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsAuroraBinLogReplicationLagAlarm An alarm that monitors the error state of Aurora writer instance replication. This alarm is used to detect whether the writer instance is in an error state and can’t replicate the source. The alarm is triggered when the value is less than or equal to threshold. #### Initializers ```typescript import { RdsAuroraBinLogReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsAuroraBinLogReplicationLagAlarm(scope: Construct, id: string, props: RdsAuroraBinLogReplicationLagAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsAuroraBinLogReplicationLagAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsAuroraBinLogReplicationLagAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsAuroraBinLogReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraBinLogReplicationLagAlarm.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 { RdsAuroraBinLogReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraBinLogReplicationLagAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsAuroraBinLogReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraBinLogReplicationLagAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsAuroraBinLogReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraBinLogReplicationLagAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsAuroraBinLogReplicationLagAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraBinLogReplicationLagAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsAuroraRecommendedAlarms A construct that creates recommended alarms for an RDS cluster. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS) #### Initializers ```typescript import { RdsAuroraRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsAuroraRecommendedAlarms(scope: Construct, id: string, props: RdsAuroraRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsAuroraRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsAuroraRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { RdsAuroraRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraRecommendedAlarms.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. | | alarmAuroraBinLogReplicationLag | RdsAuroraBinLogReplicationLagAlarm | The Bin Log Replication lag alarm for the database cluster. | | alarmAuroraVolumeBytesLeftTotal | RdsAuroraVolumeBytesLeftTotalAlarm | The AuroraVolumeBytesLeftTotal alarm for the database cluster. | | alarmAuroraVolumeBytesUsed | RdsAuroraVolumeBytesUsedAlarm | The VolumeBytesUsed anomaly detection alarm for the database cluster. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmAuroraBinLogReplicationLag`^Optional ```typescript public readonly alarmAuroraBinLogReplicationLag: RdsAuroraBinLogReplicationLagAlarm; ``` - *Type:* RdsAuroraBinLogReplicationLagAlarm The Bin Log Replication lag alarm for the database cluster. --- ##### `alarmAuroraVolumeBytesLeftTotal`^Optional ```typescript public readonly alarmAuroraVolumeBytesLeftTotal: RdsAuroraVolumeBytesLeftTotalAlarm; ``` - *Type:* RdsAuroraVolumeBytesLeftTotalAlarm The AuroraVolumeBytesLeftTotal alarm for the database cluster. --- ##### `alarmAuroraVolumeBytesUsed`^Optional ```typescript public readonly alarmAuroraVolumeBytesUsed: RdsAuroraVolumeBytesUsedAlarm; ``` - *Type:* RdsAuroraVolumeBytesUsedAlarm The VolumeBytesUsed anomaly detection alarm for the database cluster. --- ### RdsAuroraVolumeBytesLeftTotalAlarm An alarm that monitors the remaining available space (in bytes) for the cluster volume. This alarm is used to detect how close the Aurora cluster is to the volume size limit. This alarm can prevent an out-of-space error that occurs when your cluster runs out of space. The alarm is triggered when the remaining available space (in bytes) is less than threshold. #### Initializers ```typescript import { RdsAuroraVolumeBytesLeftTotalAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsAuroraVolumeBytesLeftTotalAlarm(scope: Construct, id: string, props: RdsAuroraVolumeBytesLeftTotalAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsAuroraVolumeBytesLeftTotalAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsAuroraVolumeBytesLeftTotalAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsAuroraVolumeBytesLeftTotalAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesLeftTotalAlarm.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 { RdsAuroraVolumeBytesLeftTotalAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesLeftTotalAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsAuroraVolumeBytesLeftTotalAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesLeftTotalAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsAuroraVolumeBytesLeftTotalAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesLeftTotalAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsAuroraVolumeBytesLeftTotalAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesLeftTotalAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsAuroraVolumeBytesUsedAlarm An anomaly detection alarm on the Aurora cluster `VolumeBytesUsed` metric. Catches abnormally fast storage growth that static thresholds can't express (Aurora storage grows automatically; the Aurora MySQL volume cap is already covered by `AuroraVolumeBytesLeftTotal`). Applies to both Aurora MySQL and Aurora PostgreSQL. #### Initializers ```typescript import { RdsAuroraVolumeBytesUsedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsAuroraVolumeBytesUsedAlarm(scope: Construct, id: string, props: RdsAuroraVolumeBytesUsedAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsAuroraVolumeBytesUsedAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsAuroraVolumeBytesUsedAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsAuroraVolumeBytesUsedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesUsedAlarm.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 { RdsAuroraVolumeBytesUsedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesUsedAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsAuroraVolumeBytesUsedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesUsedAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsAuroraVolumeBytesUsedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesUsedAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsAuroraVolumeBytesUsedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsAuroraVolumeBytesUsedAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsInstanceCpuUtilizationAlarm An alarm that monitors CPU utilization for an RDS instance. This alarm is used to detect consistent high CPU utilization in order to prevent very high response time and time-outs. The alarm is triggered when the CPU utilization exceeds the % threshold. #### Initializers ```typescript import { RdsInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceCpuUtilizationAlarm(scope: Construct, id: string, props: RdsInstanceCpuUtilizationAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsInstanceCpuUtilizationAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsInstanceCpuUtilizationAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceCpuUtilizationAlarm.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 { RdsInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceCpuUtilizationAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceCpuUtilizationAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceCpuUtilizationAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsInstanceCpuUtilizationAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceCpuUtilizationAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsInstanceDatabaseConnectionsAlarm An alarm that monitors the number of client network connections to the database instance. This alarm is used to help prevent rejected connections when the maximum number of DB connections is reached. The alarm is triggered when number of connections is greater than threshold. #### Initializers ```typescript import { RdsInstanceDatabaseConnectionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceDatabaseConnectionsAlarm(scope: Construct, id: string, props: RdsInstanceDatabaseConnectionsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsInstanceDatabaseConnectionsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsInstanceDatabaseConnectionsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsInstanceDatabaseConnectionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDatabaseConnectionsAlarm.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 { RdsInstanceDatabaseConnectionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDatabaseConnectionsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsInstanceDatabaseConnectionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDatabaseConnectionsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsInstanceDatabaseConnectionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDatabaseConnectionsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsInstanceDatabaseConnectionsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDatabaseConnectionsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsInstanceDbLoadAlarm An alarm that monitors the number of concurrent active sessions on the database. This alarm helps to monitor high DB load. If the number of processes exceed the number of vCPUs, the processes start queuing. When the queuing increases, the performance is impacted. The alarm is triggered when the number of active sessions for the database is greater than threshold. #### Initializers ```typescript import { RdsInstanceDbLoadAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceDbLoadAlarm(scope: Construct, id: string, props: RdsInstanceDbLoadAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsInstanceDbLoadAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsInstanceDbLoadAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsInstanceDbLoadAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDbLoadAlarm.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 { RdsInstanceDbLoadAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDbLoadAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsInstanceDbLoadAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDbLoadAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsInstanceDbLoadAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDbLoadAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsInstanceDbLoadAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceDbLoadAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsInstanceFreeableMemoryAlarm An alarm that monitors the amount of available memory (RAM) on the RDS instance. This alarm is used to help prevent running out of memory which can result in rejected connections. The alarm is triggered when the percentage of available memory is less than threshold. #### Initializers ```typescript import { RdsInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceFreeableMemoryAlarm(scope: Construct, id: string, props: RdsInstanceFreeableMemoryAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsInstanceFreeableMemoryAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsInstanceFreeableMemoryAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeableMemoryAlarm.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 { RdsInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeableMemoryAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeableMemoryAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeableMemoryAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsInstanceFreeableMemoryAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeableMemoryAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsInstanceFreeLocalStorageAlarm An alarm that monitors the amount of available local storage space for an Aurora instance used for temporary files. This alarm is used to detect how close the Aurora DB instance is to reaching the local storage limit. This alarm can prevent an out-of-space error that occurs when your DB instance runs out of local storage. The alarm is triggered when the amount of available local storage space (bytes) is less than threshold. #### Initializers ```typescript import { RdsInstanceFreeLocalStorageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceFreeLocalStorageAlarm(scope: Construct, id: string, props: RdsInstanceFreeLocalStorageAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsInstanceFreeLocalStorageAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsInstanceFreeLocalStorageAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsInstanceFreeLocalStorageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeLocalStorageAlarm.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 { RdsInstanceFreeLocalStorageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeLocalStorageAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsInstanceFreeLocalStorageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeLocalStorageAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsInstanceFreeLocalStorageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeLocalStorageAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsInstanceFreeLocalStorageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeLocalStorageAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsInstanceFreeStorageSpaceAlarm An alarm that monitors the amount of available storage space for an Aurora instance. This alarm helps prevent storage full issues. This can prevent downtime that occurs when your database instance runs out of storage. The alarm is triggered when the amount of available storage space (bytes) is less than threshold. #### Initializers ```typescript import { RdsInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceFreeStorageSpaceAlarm(scope: Construct, id: string, props: RdsInstanceFreeStorageSpaceAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsInstanceFreeStorageSpaceAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsInstanceFreeStorageSpaceAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeStorageSpaceAlarm.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 { RdsInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeStorageSpaceAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeStorageSpaceAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeStorageSpaceAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsInstanceFreeStorageSpaceAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceFreeStorageSpaceAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsInstanceReadLatencyAlarm An alarm that monitors the average amount of time taken per disk read I/O operation. This alarm is used to detect high read latency. Database disks normally have a low read/write latency, but they can have issues that can cause high latency operations. The alarm is triggered when the average amount of time per disk read operation (in milliseconds) is greater than threshold. #### Initializers ```typescript import { RdsInstanceReadLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceReadLatencyAlarm(scope: Construct, id: string, props: RdsInstanceReadLatencyAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsInstanceReadLatencyAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsInstanceReadLatencyAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsInstanceReadLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceReadLatencyAlarm.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 { RdsInstanceReadLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceReadLatencyAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsInstanceReadLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceReadLatencyAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsInstanceReadLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceReadLatencyAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsInstanceReadLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceReadLatencyAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### RdsInstanceRecommendedAlarms A construct that creates recommended alarms for an RDS cluster instance. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS) #### Initializers ```typescript import { RdsInstanceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceRecommendedAlarms(scope: Construct, id: string, props: RdsInstanceRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsInstanceRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsInstanceRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { RdsInstanceRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceRecommendedAlarms.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. | | alarmCpuUtilization | RdsInstanceCpuUtilizationAlarm | The CpuUtilization alarm for the database instance. | | alarmDatabaseConnections | RdsInstanceDatabaseConnectionsAlarm | The DatabaseConnections alarm for the database instance. | | alarmDbLoad | RdsInstanceDbLoadAlarm | The DbLoad alarm for the database instance. | | alarmFreeableMemory | RdsInstanceFreeableMemoryAlarm | The FreeableMemory alarm for the database instance. | | alarmFreeLocalStorage | RdsInstanceFreeLocalStorageAlarm | The FreeLocalStorage alarm for the database instance. | | alarmFreeStorageSpace | RdsInstanceFreeStorageSpaceAlarm | The FreeStorageSpace alarm for the database instance. | | alarmReadLatency | RdsInstanceReadLatencyAlarm | The ReadLatency alarm for the database instance. | | alarmWriteLatency | RdsInstanceWriteLatencyAlarm | The WriteLatency alarm for the database instance. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmCpuUtilization`^Optional ```typescript public readonly alarmCpuUtilization: RdsInstanceCpuUtilizationAlarm; ``` - *Type:* RdsInstanceCpuUtilizationAlarm The CpuUtilization alarm for the database instance. --- ##### `alarmDatabaseConnections`^Optional ```typescript public readonly alarmDatabaseConnections: RdsInstanceDatabaseConnectionsAlarm; ``` - *Type:* RdsInstanceDatabaseConnectionsAlarm The DatabaseConnections alarm for the database instance. --- ##### `alarmDbLoad`^Optional ```typescript public readonly alarmDbLoad: RdsInstanceDbLoadAlarm; ``` - *Type:* RdsInstanceDbLoadAlarm The DbLoad alarm for the database instance. --- ##### `alarmFreeableMemory`^Optional ```typescript public readonly alarmFreeableMemory: RdsInstanceFreeableMemoryAlarm; ``` - *Type:* RdsInstanceFreeableMemoryAlarm The FreeableMemory alarm for the database instance. --- ##### `alarmFreeLocalStorage`^Optional ```typescript public readonly alarmFreeLocalStorage: RdsInstanceFreeLocalStorageAlarm; ``` - *Type:* RdsInstanceFreeLocalStorageAlarm The FreeLocalStorage alarm for the database instance. --- ##### `alarmFreeStorageSpace`^Optional ```typescript public readonly alarmFreeStorageSpace: RdsInstanceFreeStorageSpaceAlarm; ``` - *Type:* RdsInstanceFreeStorageSpaceAlarm The FreeStorageSpace alarm for the database instance. --- ##### `alarmReadLatency`^Optional ```typescript public readonly alarmReadLatency: RdsInstanceReadLatencyAlarm; ``` - *Type:* RdsInstanceReadLatencyAlarm The ReadLatency alarm for the database instance. --- ##### `alarmWriteLatency`^Optional ```typescript public readonly alarmWriteLatency: RdsInstanceWriteLatencyAlarm; ``` - *Type:* RdsInstanceWriteLatencyAlarm The WriteLatency alarm for the database instance. --- ### RdsInstanceWriteLatencyAlarm An alarm that monitors the average amount of time taken per disk write I/O operation. This alarm is used to detect high write latency. Database disks normally have a low read/write latency, but they can have issues that can cause high latency operations. The alarm is triggered when the average amount of time per disk write operation (in milliseconds) is greater than threshold. #### Initializers ```typescript import { RdsInstanceWriteLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceWriteLatencyAlarm(scope: Construct, id: string, props: RdsInstanceWriteLatencyAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | RdsInstanceWriteLatencyAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* RdsInstanceWriteLatencyAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { RdsInstanceWriteLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceWriteLatencyAlarm.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 { RdsInstanceWriteLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceWriteLatencyAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RdsInstanceWriteLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceWriteLatencyAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { RdsInstanceWriteLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceWriteLatencyAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { RdsInstanceWriteLatencyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' RdsInstanceWriteLatencyAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### ReplicationInstance An extension for the CfnReplicationInstance construct that provides methods to create recommended alarms. #### Initializers ```typescript import { ReplicationInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ReplicationInstance(scope: Construct, id: string, props: CfnReplicationInstanceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_dms.CfnReplicationInstanceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_dms.CfnReplicationInstanceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | | inspect | Examines the CloudFormation resource and discloses attributes. | | alarmCpuUtilization | Creates an alarm that monitors the CPU utilization for the Replication Instance. | | alarmFreeableMemory | Creates an alarm that monitors the FreeableMemory for the Replication Instance. | | alarmFreeStorageSpace | Creates an alarm that monitors the Free Storage Space for the Replication Instance. | | alarmSwapUsage | Creates an alarm that monitors the Swap Usage for the Replication Instance. | | alarmWriteIops | Creates an alarm that monitors the Write IOPS for the Replication Instance. | | applyRecommendedAlarms | Creates the recommended alarms for the DMS Replication Instance. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. 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`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- ##### `inspect` ```typescript public inspect(inspector: TreeInspector): void ``` Examines the CloudFormation resource and discloses attributes. ###### `inspector`^Required - *Type:* aws-cdk-lib.TreeInspector tree inspector to collect and process attributes. --- ##### `alarmCpuUtilization` ```typescript public alarmCpuUtilization(props?: DmsCpuUtilizationAlarmConfig): DmsReplicationInstanceCpuUtilizationAlarm ``` Creates an alarm that monitors the CPU utilization for the Replication Instance. ###### `props`^Optional - *Type:* DmsCpuUtilizationAlarmConfig --- ##### `alarmFreeableMemory` ```typescript public alarmFreeableMemory(props: DmsFreeableMemoryAlarmConfig): DmsReplicationInstanceFreeableMemoryAlarm ``` Creates an alarm that monitors the FreeableMemory for the Replication Instance. ###### `props`^Required - *Type:* DmsFreeableMemoryAlarmConfig --- ##### `alarmFreeStorageSpace` ```typescript public alarmFreeStorageSpace(props: DmsFreeStorageSpaceAlarmConfig): DmsReplicationInstanceFreeStorageSpaceAlarm ``` Creates an alarm that monitors the Free Storage Space for the Replication Instance. ###### `props`^Required - *Type:* DmsFreeStorageSpaceAlarmConfig --- ##### `alarmSwapUsage` ```typescript public alarmSwapUsage(props?: DmsSwapUsageAlarmConfig): DmsReplicationInstanceSwapUsageAlarm ``` Creates an alarm that monitors the Swap Usage for the Replication Instance. ###### `props`^Optional - *Type:* DmsSwapUsageAlarmConfig --- ##### `alarmWriteIops` ```typescript public alarmWriteIops(props?: DmsWriteIopsAlarmConfig): DmsReplicationInstanceWriteIopsAlarm ``` Creates an alarm that monitors the Write IOPS for the Replication Instance. ###### `props`^Optional - *Type:* DmsWriteIopsAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: DmsReplicationInstanceRecommendedAlarmsConfig): DmsReplicationInstanceRecommendedAlarms ``` Creates the recommended alarms for the DMS Replication Instance. > [https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/](https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/) ###### `props`^Required - *Type:* DmsReplicationInstanceRecommendedAlarmsConfig --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | | isCfnReplicationInstance | Checks whether the given object is a CfnReplicationInstance. | --- ##### `isConstruct` ```typescript import { ReplicationInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' ReplicationInstance.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. --- ##### `isCfnElement` ```typescript import { ReplicationInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' ReplicationInstance.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { ReplicationInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' ReplicationInstance.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- ##### `isCfnReplicationInstance` ```typescript import { ReplicationInstance } from '@renovosolutions/cdk-library-cloudwatch-alarms' ReplicationInstance.isCfnReplicationInstance(x: any) ``` Checks whether the given object is a CfnReplicationInstance. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | *No description.* | | attrId | string | *No description.* | | attrReplicationInstancePrivateIpAddresses | string | One or more private IP addresses for the replication instance. | | attrReplicationInstancePublicIpAddresses | string | One or more public IP addresses for the replication instance. | | replicationInstanceRef | aws-cdk-lib.interfaces.aws_dms.ReplicationInstanceReference | A reference to a ReplicationInstance resource. | | tags | aws-cdk-lib.TagManager | Tag Manager which manages the tags for this resource. | | replicationInstanceClass | string | The compute and memory capacity of the replication instance as defined for the specified replication instance class. | | allocatedStorage | number | The amount of storage (in gigabytes) to be initially allocated for the replication instance. | | allowMajorVersionUpgrade | boolean \| aws-cdk-lib.IResolvable | Indicates that major version upgrades are allowed. | | autoMinorVersionUpgrade | boolean \| aws-cdk-lib.IResolvable | A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. | | availabilityZone | string | The Availability Zone that the replication instance will be created in. | | dnsNameServers | string | A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. | | engineVersion | string | The engine version number of the replication instance. | | kmsKeyId | string | An AWS key identifier that is used to encrypt the data on the replication instance. | | multiAz | boolean \| aws-cdk-lib.IResolvable | Specifies whether the replication instance is a Multi-AZ deployment. | | networkType | string | The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. | | preferredMaintenanceWindow | string | The weekly time range during which system maintenance can occur, in UTC. | | publiclyAccessible | boolean \| aws-cdk-lib.IResolvable | Specifies the accessibility options for the replication instance. | | replicationInstanceIdentifier | string | The replication instance identifier. | | replicationSubnetGroupIdentifier | string | A subnet group to associate with the replication instance. | | resourceIdentifier | string | A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. | | tagsRaw | aws-cdk-lib.CfnTag[] | One or more tags to be assigned to the replication instance. | | vpcSecurityGroupIds | string[] | Specifies the virtual private cloud (VPC) security group to be used with the replication instance. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string --- ##### `attrReplicationInstancePrivateIpAddresses`^Required ```typescript public readonly attrReplicationInstancePrivateIpAddresses: string; ``` - *Type:* string One or more private IP addresses for the replication instance. --- ##### `attrReplicationInstancePublicIpAddresses`^Required ```typescript public readonly attrReplicationInstancePublicIpAddresses: string; ``` - *Type:* string One or more public IP addresses for the replication instance. --- ##### `replicationInstanceRef`^Required ```typescript public readonly replicationInstanceRef: ReplicationInstanceReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_dms.ReplicationInstanceReference A reference to a ReplicationInstance resource. --- ##### `tags`^Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager Tag Manager which manages the tags for this resource. --- ##### `replicationInstanceClass`^Required ```typescript public readonly replicationInstanceClass: string; ``` - *Type:* string The compute and memory capacity of the replication instance as defined for the specified replication instance class. --- ##### `allocatedStorage`^Optional ```typescript public readonly allocatedStorage: number; ``` - *Type:* number The amount of storage (in gigabytes) to be initially allocated for the replication instance. --- ##### `allowMajorVersionUpgrade`^Optional ```typescript public readonly allowMajorVersionUpgrade: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable Indicates that major version upgrades are allowed. --- ##### `autoMinorVersionUpgrade`^Optional ```typescript public readonly autoMinorVersionUpgrade: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable A value that indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window. --- ##### `availabilityZone`^Optional ```typescript public readonly availabilityZone: string; ``` - *Type:* string The Availability Zone that the replication instance will be created in. --- ##### `dnsNameServers`^Optional ```typescript public readonly dnsNameServers: string; ``` - *Type:* string A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. --- ##### `engineVersion`^Optional ```typescript public readonly engineVersion: string; ``` - *Type:* string The engine version number of the replication instance. --- ##### `kmsKeyId`^Optional ```typescript public readonly kmsKeyId: string; ``` - *Type:* string An AWS key identifier that is used to encrypt the data on the replication instance. --- ##### `multiAz`^Optional ```typescript public readonly multiAz: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable Specifies whether the replication instance is a Multi-AZ deployment. --- ##### `networkType`^Optional ```typescript public readonly networkType: string; ``` - *Type:* string The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. --- ##### `preferredMaintenanceWindow`^Optional ```typescript public readonly preferredMaintenanceWindow: string; ``` - *Type:* string The weekly time range during which system maintenance can occur, in UTC. --- ##### `publiclyAccessible`^Optional ```typescript public readonly publiclyAccessible: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable Specifies the accessibility options for the replication instance. --- ##### `replicationInstanceIdentifier`^Optional ```typescript public readonly replicationInstanceIdentifier: string; ``` - *Type:* string The replication instance identifier. This parameter is stored as a lowercase string. --- ##### `replicationSubnetGroupIdentifier`^Optional ```typescript public readonly replicationSubnetGroupIdentifier: string; ``` - *Type:* string A subnet group to associate with the replication instance. --- ##### `resourceIdentifier`^Optional ```typescript public readonly resourceIdentifier: string; ``` - *Type:* string A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. --- ##### `tagsRaw`^Optional ```typescript public readonly tagsRaw: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] One or more tags to be assigned to the replication instance. --- ##### `vpcSecurityGroupIds`^Optional ```typescript public readonly vpcSecurityGroupIds: string[]; ``` - *Type:* string[] Specifies the virtual private cloud (VPC) security group to be used with the replication instance. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### ReplicationTask An extension for the CfnReplicationTask construct that provides methods to create recommended alarms. #### Initializers ```typescript import { ReplicationTask } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ReplicationTask(scope: Construct, id: string, props: ReplicationTaskProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | ReplicationTaskProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* ReplicationTaskProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | | inspect | Examines the CloudFormation resource and discloses attributes. | | alarmCdcLatencySource | Creates an alarm that monitors the CDC latency from the source for the Replication Task. | | alarmCdcLatencyTarget | Creates an alarm that monitors the CDC latency to the target for the Replication Task. | | applyRecommendedAlarms | Creates the recommended alarms for the DMS Replication Task. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. 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`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- ##### `inspect` ```typescript public inspect(inspector: TreeInspector): void ``` Examines the CloudFormation resource and discloses attributes. ###### `inspector`^Required - *Type:* aws-cdk-lib.TreeInspector tree inspector to collect and process attributes. --- ##### `alarmCdcLatencySource` ```typescript public alarmCdcLatencySource(props?: DmsCdcLatencySourceAlarmConfig): DmsReplicationTaskCdcLatencySourceAlarm ``` Creates an alarm that monitors the CDC latency from the source for the Replication Task. ###### `props`^Optional - *Type:* DmsCdcLatencySourceAlarmConfig --- ##### `alarmCdcLatencyTarget` ```typescript public alarmCdcLatencyTarget(props?: DmsCdcLatencyTargetAlarmConfig): DmsReplicationTaskCdcLatencyTargetAlarm ``` Creates an alarm that monitors the CDC latency to the target for the Replication Task. ###### `props`^Optional - *Type:* DmsCdcLatencyTargetAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props?: DmsReplicationTaskRecommendedAlarmsConfig): DmsReplicationTaskRecommendedAlarms ``` Creates the recommended alarms for the DMS Replication Task. > [https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/](https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/) ###### `props`^Optional - *Type:* DmsReplicationTaskRecommendedAlarmsConfig --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | | isCfnReplicationTask | Checks whether the given object is a CfnReplicationTask. | --- ##### `isConstruct` ```typescript import { ReplicationTask } from '@renovosolutions/cdk-library-cloudwatch-alarms' ReplicationTask.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. --- ##### `isCfnElement` ```typescript import { ReplicationTask } from '@renovosolutions/cdk-library-cloudwatch-alarms' ReplicationTask.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { ReplicationTask } from '@renovosolutions/cdk-library-cloudwatch-alarms' ReplicationTask.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- ##### `isCfnReplicationTask` ```typescript import { ReplicationTask } from '@renovosolutions/cdk-library-cloudwatch-alarms' ReplicationTask.isCfnReplicationTask(x: any) ``` Checks whether the given object is a CfnReplicationTask. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | *No description.* | | attrId | string | *No description.* | | replicationTaskRef | aws-cdk-lib.interfaces.aws_dms.ReplicationTaskReference | A reference to a ReplicationTask resource. | | tags | aws-cdk-lib.TagManager | Tag Manager which manages the tags for this resource. | | migrationType | string | The migration type. | | replicationInstanceArn | string | The Amazon Resource Name (ARN) of a replication instance. | | sourceEndpointArn | string | An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. | | tableMappings | string | The table mappings for the task, in JSON format. | | targetEndpointArn | string | An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. | | cdcStartPosition | string | Indicates when you want a change data capture (CDC) operation to start. | | cdcStartTime | number | Indicates the start time for a change data capture (CDC) operation. | | cdcStopPosition | string | Indicates when you want a change data capture (CDC) operation to stop. | | replicationTaskIdentifier | string | An identifier for the replication task. | | replicationTaskSettings | string | Overall settings for the task, in JSON format. | | resourceIdentifier | string | A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. | | tagsRaw | aws-cdk-lib.CfnTag[] | One or more tags to be assigned to the replication task. | | taskData | string | Supplemental information that the task requires to migrate the data for certain source and target endpoints. | | replicationInstanceIdentifier | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment --- ##### `attrId`^Required ```typescript public readonly attrId: string; ``` - *Type:* string --- ##### `replicationTaskRef`^Required ```typescript public readonly replicationTaskRef: ReplicationTaskReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_dms.ReplicationTaskReference A reference to a ReplicationTask resource. --- ##### `tags`^Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager Tag Manager which manages the tags for this resource. --- ##### `migrationType`^Required ```typescript public readonly migrationType: string; ``` - *Type:* string The migration type. --- ##### `replicationInstanceArn`^Required ```typescript public readonly replicationInstanceArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of a replication instance. --- ##### `sourceEndpointArn`^Required ```typescript public readonly sourceEndpointArn: string; ``` - *Type:* string An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. --- ##### `tableMappings`^Required ```typescript public readonly tableMappings: string; ``` - *Type:* string The table mappings for the task, in JSON format. --- ##### `targetEndpointArn`^Required ```typescript public readonly targetEndpointArn: string; ``` - *Type:* string An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. --- ##### `cdcStartPosition`^Optional ```typescript public readonly cdcStartPosition: string; ``` - *Type:* string Indicates when you want a change data capture (CDC) operation to start. --- ##### `cdcStartTime`^Optional ```typescript public readonly cdcStartTime: number; ``` - *Type:* number Indicates the start time for a change data capture (CDC) operation. --- ##### `cdcStopPosition`^Optional ```typescript public readonly cdcStopPosition: string; ``` - *Type:* string Indicates when you want a change data capture (CDC) operation to stop. --- ##### `replicationTaskIdentifier`^Optional ```typescript public readonly replicationTaskIdentifier: string; ``` - *Type:* string An identifier for the replication task. --- ##### `replicationTaskSettings`^Optional ```typescript public readonly replicationTaskSettings: string; ``` - *Type:* string Overall settings for the task, in JSON format. --- ##### `resourceIdentifier`^Optional ```typescript public readonly resourceIdentifier: string; ``` - *Type:* string A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. --- ##### `tagsRaw`^Optional ```typescript public readonly tagsRaw: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] One or more tags to be assigned to the replication task. --- ##### `taskData`^Optional ```typescript public readonly taskData: string; ``` - *Type:* string Supplemental information that the task requires to migrate the data for certain source and target endpoints. --- ##### `replicationInstanceIdentifier`^Required ```typescript public readonly replicationInstanceIdentifier: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### RestApi An extension for the RestApi construct that provides methods to create recommended alarms. #### Initializers ```typescript import { RestApi } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RestApi(scope: Construct, id: string, props: RestApiBaseProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_apigateway.RestApiBaseProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_apigateway.RestApiBaseProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addApiKey | Add an ApiKey to the deploymentStage. | | addDomainName | Defines an API Gateway domain name and maps it to this API. | | addGatewayResponse | Adds a new gateway response. | | addToResourcePolicy | Adds a statement to the resource policy associated with this rest api. | | addUsagePlan | Adds a usage plan. | | arnForExecuteApi | Gets the "execute-api" ARN. | | grantInvokeFromVpcEndpointsOnly | Add a resource policy that only allows API execution from a VPC Endpoint to create a private API. | | metric | Returns the given named metric for this API. | | metricCacheHitCount | Metric for the number of requests served from the API cache in a given period. | | metricCacheMissCount | Metric for the number of requests served from the backend in a given period, when API caching is enabled. | | metricClientError | Metric for the number of client-side errors captured in a given period. | | metricCount | Metric for the total number API requests in a given period. | | metricIntegrationLatency | Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend. | | metricLatency | The time between when API Gateway receives a request from a client and when it returns a response to the client. | | metricServerError | Metric for the number of server-side errors captured in a given period. | | urlForPath | Returns the URL for an HTTP path. | | addModel | Adds a new model. | | addRequestValidator | Adds a new request validator. | | alarm4XXError | Creates an alarm that monitors the number of client-side errors captured in a given period. | | alarm5XXError | Creates an alarm that monitors the number of server-side errors captured in a given period. | | alarmCountAnomaly | Creates an anomaly detection alarm on the Count metric. | | alarmDetailedLatency | Creates a list of alarms the time between when API Gateway receives a request from a client and when it returns a response to the client for the methods and resources specified. | | alarmIntegrationLatencyAnomaly | Creates an anomaly detection alarm on the IntegrationLatency metric. | | alarmLatency | Creates an alarm that monitors the time between when API Gateway receives a request from a client and when it returns a response to the client. | | alarmLatencyAnomaly | Creates an anomaly detection alarm on the Latency metric. | | applyRecommendedAlarms | Creates the recommended alarms for the ApiGateway api. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addApiKey` ```typescript public addApiKey(id: string, options?: ApiKeyOptions): IApiKey ``` Add an ApiKey to the deploymentStage. ###### `id`^Required - *Type:* string --- ###### `options`^Optional - *Type:* aws-cdk-lib.aws_apigateway.ApiKeyOptions --- ##### `addDomainName` ```typescript public addDomainName(id: string, options: DomainNameOptions): DomainName ``` Defines an API Gateway domain name and maps it to this API. ###### `id`^Required - *Type:* string The construct id. --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_apigateway.DomainNameOptions custom domain options. --- ##### `addGatewayResponse` ```typescript public addGatewayResponse(id: string, options: GatewayResponseOptions): GatewayResponse ``` Adds a new gateway response. ###### `id`^Required - *Type:* string --- ###### `options`^Required - *Type:* aws-cdk-lib.aws_apigateway.GatewayResponseOptions --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the resource policy associated with this rest api. A resource policy will be automatically created upon the first call to `addToResourcePolicy`. Note that this does not work with imported rest api. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement The policy statement to add. --- ##### `addUsagePlan` ```typescript public addUsagePlan(id: string, props?: UsagePlanProps): UsagePlan ``` Adds a usage plan. ###### `id`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_apigateway.UsagePlanProps --- ##### `arnForExecuteApi` ```typescript public arnForExecuteApi(method?: string, path?: string, stage?: string): string ``` Gets the "execute-api" ARN. ###### `method`^Optional - *Type:* string --- ###### `path`^Optional - *Type:* string --- ###### `stage`^Optional - *Type:* string --- ##### `grantInvokeFromVpcEndpointsOnly` ```typescript public grantInvokeFromVpcEndpointsOnly(vpcEndpoints: IVpcEndpoint[]): void ``` Add a resource policy that only allows API execution from a VPC Endpoint to create a private API. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies-examples.html#apigateway-resource-policies-source-vpc-example](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies-examples.html#apigateway-resource-policies-source-vpc-example) ###### `vpcEndpoints`^Required - *Type:* aws-cdk-lib.aws_ec2.IVpcEndpoint[] the interface VPC endpoints to grant access to. --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Returns the given named metric for this API. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCacheHitCount` ```typescript public metricCacheHitCount(props?: MetricOptions): Metric ``` Metric for the number of requests served from the API cache in a given period. Default: sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCacheMissCount` ```typescript public metricCacheMissCount(props?: MetricOptions): Metric ``` Metric for the number of requests served from the backend in a given period, when API caching is enabled. Default: sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricClientError` ```typescript public metricClientError(props?: MetricOptions): Metric ``` Metric for the number of client-side errors captured in a given period. Default: sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricCount` ```typescript public metricCount(props?: MetricOptions): Metric ``` Metric for the total number API requests in a given period. Default: sample count over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricIntegrationLatency` ```typescript public metricIntegrationLatency(props?: MetricOptions): Metric ``` Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend. Default: average over 5 minutes. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricLatency` ```typescript public metricLatency(props?: MetricOptions): Metric ``` The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead. Default: average over 5 minutes. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricServerError` ```typescript public metricServerError(props?: MetricOptions): Metric ``` Metric for the number of server-side errors captured in a given period. Default: sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `urlForPath` ```typescript public urlForPath(path?: string): string ``` Returns the URL for an HTTP path. Fails if `deploymentStage` is not set either by `deploy` or explicitly. ###### `path`^Optional - *Type:* string --- ##### `addModel` ```typescript public addModel(id: string, props: ModelOptions): Model ``` Adds a new model. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_apigateway.ModelOptions --- ##### `addRequestValidator` ```typescript public addRequestValidator(id: string, props: RequestValidatorOptions): RequestValidator ``` Adds a new request validator. ###### `id`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_apigateway.RequestValidatorOptions --- ##### `alarm4XXError` ```typescript public alarm4XXError(props: ApiGateway4XXErrorAlarmConfig): ApiGatewayRestApi4XXErrorAlarm ``` Creates an alarm that monitors the number of client-side errors captured in a given period. ###### `props`^Required - *Type:* ApiGateway4XXErrorAlarmConfig --- ##### `alarm5XXError` ```typescript public alarm5XXError(props: ApiGateway5XXErrorAlarmConfig): ApiGatewayRestApi5XXErrorAlarm ``` Creates an alarm that monitors the number of server-side errors captured in a given period. ###### `props`^Required - *Type:* ApiGateway5XXErrorAlarmConfig --- ##### `alarmCountAnomaly` ```typescript public alarmCountAnomaly(props?: ApiGatewayCountAnomalyAlarmConfig): ApiGatewayRestApiCountAnomalyAlarm ``` Creates an anomaly detection alarm on the Count metric. By default detects both unexpected traffic drops and spikes for low-traffic APIs where a static count threshold is hard to pick. ###### `props`^Optional - *Type:* ApiGatewayCountAnomalyAlarmConfig --- ##### `alarmDetailedLatency` ```typescript public alarmDetailedLatency(props: ApiGatewayRestApiDetailedLatencyAlarmConfig[]): ApiGatewayRestApiDetailedLatencyAlarm[] ``` Creates a list of alarms the time between when API Gateway receives a request from a client and when it returns a response to the client for the methods and resources specified. ###### `props`^Required - *Type:* ApiGatewayRestApiDetailedLatencyAlarmConfig[] --- ##### `alarmIntegrationLatencyAnomaly` ```typescript public alarmIntegrationLatencyAnomaly(props?: ApiGatewayIntegrationLatencyAnomalyAlarmConfig): ApiGatewayRestApiIntegrationLatencyAnomalyAlarm ``` Creates an anomaly detection alarm on the IntegrationLatency metric. Catches backend integration latency drift independently of API Gateway overhead. ###### `props`^Optional - *Type:* ApiGatewayIntegrationLatencyAnomalyAlarmConfig --- ##### `alarmLatency` ```typescript public alarmLatency(props?: ApiGatewayLatencyAlarmConfig): ApiGatewayRestApiLatencyAlarm ``` Creates an alarm that monitors the time between when API Gateway receives a request from a client and when it returns a response to the client. ###### `props`^Optional - *Type:* ApiGatewayLatencyAlarmConfig --- ##### `alarmLatencyAnomaly` ```typescript public alarmLatencyAnomaly(props?: ApiGatewayLatencyAnomalyAlarmConfig): ApiGatewayRestApiLatencyAnomalyAlarm ``` Creates an anomaly detection alarm on the Latency metric. Detects drift in total request latency without requiring a static threshold; intended to coexist with the static `Latency` alarm. ###### `props`^Optional - *Type:* ApiGatewayLatencyAnomalyAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: ApiGatewayRestApiRecommendedAlarmsConfig): ApiGatewayRestApiRecommendedAlarms ``` Creates the recommended alarms for the ApiGateway api. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway) ###### `props`^Required - *Type:* ApiGatewayRestApiRecommendedAlarmsConfig --- #### 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. | | fromRestApiAttributes | Import an existing RestApi that can be configured with additional Methods and Resources. | | fromRestApiId | Import an existing RestApi. | | isRestApi | Return whether the given object is a `RestApi`. | --- ##### `isConstruct` ```typescript import { RestApi } from '@renovosolutions/cdk-library-cloudwatch-alarms' RestApi.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 { RestApi } from '@renovosolutions/cdk-library-cloudwatch-alarms' RestApi.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { RestApi } from '@renovosolutions/cdk-library-cloudwatch-alarms' RestApi.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromRestApiAttributes` ```typescript import { RestApi } from '@renovosolutions/cdk-library-cloudwatch-alarms' RestApi.fromRestApiAttributes(scope: Construct, id: string, attrs: RestApiAttributes) ``` Import an existing RestApi that can be configured with additional Methods and Resources. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_apigateway.RestApiAttributes --- ##### `fromRestApiId` ```typescript import { RestApi } from '@renovosolutions/cdk-library-cloudwatch-alarms' RestApi.fromRestApiId(scope: Construct, id: string, restApiId: string) ``` Import an existing RestApi. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `restApiId`^Required - *Type:* string --- ##### `isRestApi` ```typescript import { RestApi } from '@renovosolutions/cdk-library-cloudwatch-alarms' RestApi.isRestApi(x: any) ``` Return whether the given object is a `RestApi`. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | restApiId | string | The ID of this API Gateway RestApi. | | restApiName | string | A human friendly name for this Rest API. | | restApiRef | aws-cdk-lib.interfaces.aws_apigateway.RestApiReference | A reference to a RestApi resource. | | restApiRootResourceId | string | The resource ID of the root resource. | | root | aws-cdk-lib.aws_apigateway.IResource | Represents the root resource of this API endpoint ('/'). | | url | string | The deployed root URL of this REST API. | | domainName | aws-cdk-lib.aws_apigateway.DomainName | The first domain name mapped to this API, if defined through the `domainName` configuration prop, or added via `addDomainName`. | | latestDeployment | aws-cdk-lib.aws_apigateway.Deployment | API Gateway deployment that represents the latest changes of the API. | | deploymentStage | aws-cdk-lib.aws_apigateway.Stage | API Gateway stage that points to the latest deployment (if defined). | | methods | aws-cdk-lib.aws_apigateway.Method[] | The list of methods bound to this RestApi. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `restApiId`^Required ```typescript public readonly restApiId: string; ``` - *Type:* string The ID of this API Gateway RestApi. --- ##### `restApiName`^Required ```typescript public readonly restApiName: string; ``` - *Type:* string A human friendly name for this Rest API. Note that this is different from `restApiId`. --- ##### `restApiRef`^Required ```typescript public readonly restApiRef: RestApiReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_apigateway.RestApiReference A reference to a RestApi resource. --- ##### `restApiRootResourceId`^Required ```typescript public readonly restApiRootResourceId: string; ``` - *Type:* string The resource ID of the root resource. --- ##### `root`^Required ```typescript public readonly root: IResource; ``` - *Type:* aws-cdk-lib.aws_apigateway.IResource Represents the root resource of this API endpoint ('/'). Resources and Methods are added to this resource. --- ##### `url`^Required ```typescript public readonly url: string; ``` - *Type:* string The deployed root URL of this REST API. --- ##### `domainName`^Optional ```typescript public readonly domainName: DomainName; ``` - *Type:* aws-cdk-lib.aws_apigateway.DomainName The first domain name mapped to this API, if defined through the `domainName` configuration prop, or added via `addDomainName`. --- ##### `latestDeployment`^Optional ```typescript public readonly latestDeployment: Deployment; ``` - *Type:* aws-cdk-lib.aws_apigateway.Deployment API Gateway deployment that represents the latest changes of the API. This resource will be automatically updated every time the REST API model changes. This will be undefined if `deploy` is false. --- ##### `deploymentStage`^Required ```typescript public readonly deploymentStage: Stage; ``` - *Type:* aws-cdk-lib.aws_apigateway.Stage API Gateway stage that points to the latest deployment (if defined). If `deploy` is disabled, you will need to explicitly assign this value in order to set up integrations. --- ##### `methods`^Required ```typescript public readonly methods: Method[]; ``` - *Type:* aws-cdk-lib.aws_apigateway.Method[] The list of methods bound to this RestApi. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### S3Bucket4xxErrorsAlarm An alarm that monitors the 4xx errors for an S3 bucket. This alarm is used to create a baseline for typical 4xx error rates so that you can look into any abnormalities that might indicate a setup issue. The alarm is triggered when the 4xx error rate exceeds the % threshold. #### Initializers ```typescript import { S3Bucket4xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new S3Bucket4xxErrorsAlarm(scope: IConstruct, id: string, props: S3Bucket4xxErrorsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | S3Bucket4xxErrorsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* S3Bucket4xxErrorsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { S3Bucket4xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket4xxErrorsAlarm.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 { S3Bucket4xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket4xxErrorsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { S3Bucket4xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket4xxErrorsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { S3Bucket4xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket4xxErrorsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { S3Bucket4xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket4xxErrorsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### S3Bucket5xxErrorsAlarm An alarm that monitors the 5xx errors for an S3 bucket. This alarm can help to detect if the application is experiencing issues due to 5xx errors. The alarm is triggered when the 5xx error rate exceeds the % threshold. #### Initializers ```typescript import { S3Bucket5xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new S3Bucket5xxErrorsAlarm(scope: IConstruct, id: string, props: S3Bucket5xxErrorsAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | S3Bucket5xxErrorsAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* S3Bucket5xxErrorsAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { S3Bucket5xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket5xxErrorsAlarm.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 { S3Bucket5xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket5xxErrorsAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { S3Bucket5xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket5xxErrorsAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { S3Bucket5xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket5xxErrorsAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { S3Bucket5xxErrorsAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3Bucket5xxErrorsAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### S3RecommendedAlarms A construct that creates the recommended alarms for an S3 bucket. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#S3](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#S3) #### Initializers ```typescript import { S3RecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new S3RecommendedAlarms(scope: Construct, id: string, props: S3RecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | S3RecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* S3RecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { S3RecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' S3RecommendedAlarms.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. | | alarm4xxErrors | S3Bucket4xxErrorsAlarm | The 4xx errors alarm. | | alarm5xxErrors | S3Bucket5xxErrorsAlarm | The 5xx errors alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarm4xxErrors`^Optional ```typescript public readonly alarm4xxErrors: S3Bucket4xxErrorsAlarm; ``` - *Type:* S3Bucket4xxErrorsAlarm The 4xx errors alarm. --- ##### `alarm5xxErrors`^Optional ```typescript public readonly alarm5xxErrors: S3Bucket5xxErrorsAlarm; ``` - *Type:* S3Bucket5xxErrorsAlarm The 5xx errors alarm. --- ### SfStateMachineExecutionsFailedAlarm It helps in tracking the number of executions that fail in AWS Step Functions. This is crucial for identifying workflows that are not performing as expected and require attention. By monitoring the failures, developers can proactively identify and resolve issues before they impact the business operations. This reduces downtime and improves the overall stability of applications. The alarm is triggered when the number of failed executions exceed the threshold. #### Initializers ```typescript import { SfStateMachineExecutionsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SfStateMachineExecutionsFailedAlarm(scope: IConstruct, id: string, props: SfStateMachineExecutionsFailedAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SfStateMachineExecutionsFailedAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SfStateMachineExecutionsFailedAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SfStateMachineExecutionsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsFailedAlarm.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 { SfStateMachineExecutionsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsFailedAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SfStateMachineExecutionsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsFailedAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SfStateMachineExecutionsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsFailedAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SfStateMachineExecutionsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsFailedAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SfStateMachineExecutionsTimedOutAlarm This alarm helps in identifying timeouts in state machine executions. This can indicate problems like poor configuration, inadequate resource allocation, or issues in the called services that need addressing. The alarm is triggered when the number of timed out executions exceed the threshold. #### Initializers ```typescript import { SfStateMachineExecutionsTimedOutAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SfStateMachineExecutionsTimedOutAlarm(scope: IConstruct, id: string, props: SfStateMachineExecutionsTimedOutAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SfStateMachineExecutionsTimedOutAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SfStateMachineExecutionsTimedOutAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SfStateMachineExecutionsTimedOutAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsTimedOutAlarm.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 { SfStateMachineExecutionsTimedOutAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsTimedOutAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SfStateMachineExecutionsTimedOutAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsTimedOutAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SfStateMachineExecutionsTimedOutAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsTimedOutAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SfStateMachineExecutionsTimedOutAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionsTimedOutAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SfStateMachineExecutionThrottledAlarm The ExecutionThrottled metric tracks the number of times state machine executions are throttled due to exceeding AWS service limits. Monitoring this can help you identify when you are hitting this limits, which could signal that adjustments need to be made either in the process design or in the service limits themselves. The alarm is triggered when the number of executions throttled exceed the threshold. #### Initializers ```typescript import { SfStateMachineExecutionThrottledAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SfStateMachineExecutionThrottledAlarm(scope: IConstruct, id: string, props: SfStateMachineExecutionThrottledAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SfStateMachineExecutionThrottledAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SfStateMachineExecutionThrottledAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SfStateMachineExecutionThrottledAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionThrottledAlarm.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 { SfStateMachineExecutionThrottledAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionThrottledAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SfStateMachineExecutionThrottledAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionThrottledAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SfStateMachineExecutionThrottledAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionThrottledAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SfStateMachineExecutionThrottledAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionThrottledAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SfStateMachineExecutionTimeAlarm This metric can be a valuable tool for early detection of issues that might not be immediately apparent from other metrics. A sudden increase in execution time might indicate issues with the steps of the resources they interact with. The alarm is triggered when the time in milliseconds exceed the threshold. #### Initializers ```typescript import { SfStateMachineExecutionTimeAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SfStateMachineExecutionTimeAlarm(scope: IConstruct, id: string, props: SfStateMachineExecutionTimeAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SfStateMachineExecutionTimeAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SfStateMachineExecutionTimeAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SfStateMachineExecutionTimeAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionTimeAlarm.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 { SfStateMachineExecutionTimeAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionTimeAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SfStateMachineExecutionTimeAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionTimeAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SfStateMachineExecutionTimeAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionTimeAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SfStateMachineExecutionTimeAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineExecutionTimeAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SfStateMachineRecommendedAlarms A construct that creates the recommended alarms for an StepFunctions StateMachine. #### Initializers ```typescript import { SfStateMachineRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SfStateMachineRecommendedAlarms(scope: Construct, id: string, props: SfStateMachineRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SfStateMachineRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SfStateMachineRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { SfStateMachineRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' SfStateMachineRecommendedAlarms.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. | | alarmExecutionsFailed | SfStateMachineExecutionsFailedAlarm | The ExecutionsFailed alarm. | | alarmExecutionsTimedOut | SfStateMachineExecutionsTimedOutAlarm | The ExecutionsTimedOut alarm. | | alarmExecutionThrottled | SfStateMachineExecutionThrottledAlarm | The ExecutionThrottled alarm. | | alarmExecutionTime | SfStateMachineExecutionTimeAlarm | The ExecutionTime alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmExecutionsFailed`^Optional ```typescript public readonly alarmExecutionsFailed: SfStateMachineExecutionsFailedAlarm; ``` - *Type:* SfStateMachineExecutionsFailedAlarm The ExecutionsFailed alarm. --- ##### `alarmExecutionsTimedOut`^Optional ```typescript public readonly alarmExecutionsTimedOut: SfStateMachineExecutionsTimedOutAlarm; ``` - *Type:* SfStateMachineExecutionsTimedOutAlarm The ExecutionsTimedOut alarm. --- ##### `alarmExecutionThrottled`^Optional ```typescript public readonly alarmExecutionThrottled: SfStateMachineExecutionThrottledAlarm; ``` - *Type:* SfStateMachineExecutionThrottledAlarm The ExecutionThrottled alarm. --- ##### `alarmExecutionTime`^Optional ```typescript public readonly alarmExecutionTime: SfStateMachineExecutionTimeAlarm; ``` - *Type:* SfStateMachineExecutionTimeAlarm The ExecutionTime alarm. --- ### SnsNumberOfMessagesPublishedAlarm An alarm that monitors the number of messages published to an SNS topic. This alarm helps you proactively monitor and detect significant drops in notification publishing. This helps you identify potential issues with your application or business processes, so that you can take appropriate actions to maintain the expected flow of notifications. You should create this alarm if you expect your system to have a minimum traffic that it is serving. The alarm is triggered when the number of messages published to the topic is less than the specified threshold. #### Initializers ```typescript import { SnsNumberOfMessagesPublishedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SnsNumberOfMessagesPublishedAlarm(scope: IConstruct, id: string, props: SnsNumberOfMessagesPublishedAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SnsNumberOfMessagesPublishedAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SnsNumberOfMessagesPublishedAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SnsNumberOfMessagesPublishedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfMessagesPublishedAlarm.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 { SnsNumberOfMessagesPublishedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfMessagesPublishedAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SnsNumberOfMessagesPublishedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfMessagesPublishedAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SnsNumberOfMessagesPublishedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfMessagesPublishedAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SnsNumberOfMessagesPublishedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfMessagesPublishedAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SnsNumberOfNotificationsDeliveredAlarm An alarm that monitors the number of notifications delivered by an SNS topic. This alarm helps you detect a drop in the volume of messages delivered. You should create this alarm if you expect your system to have a minimum traffic that it is serving. The alarm is triggered when the number of messages delivered by the topic is less than the specified threshold. #### Initializers ```typescript import { SnsNumberOfNotificationsDeliveredAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SnsNumberOfNotificationsDeliveredAlarm(scope: IConstruct, id: string, props: SnsNumberOfNotificationsDeliveredAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SnsNumberOfNotificationsDeliveredAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SnsNumberOfNotificationsDeliveredAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SnsNumberOfNotificationsDeliveredAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsDeliveredAlarm.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 { SnsNumberOfNotificationsDeliveredAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsDeliveredAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SnsNumberOfNotificationsDeliveredAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsDeliveredAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SnsNumberOfNotificationsDeliveredAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsDeliveredAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SnsNumberOfNotificationsDeliveredAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsDeliveredAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SnsNumberOfNotificationsFailedAlarm An alarm that monitors the number of notifications failed by an SNS topic. This alarm helps you proactively find issues with the delivery of notifications and take appropriate actions to address them. The alarm is triggered when the number of messages failed by the topic is greater than the specified threshold. #### Initializers ```typescript import { SnsNumberOfNotificationsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SnsNumberOfNotificationsFailedAlarm(scope: IConstruct, id: string, props: SnsNumberOfNotificationsFailedAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SnsNumberOfNotificationsFailedAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SnsNumberOfNotificationsFailedAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SnsNumberOfNotificationsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedAlarm.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 { SnsNumberOfNotificationsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SnsNumberOfNotificationsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SnsNumberOfNotificationsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SnsNumberOfNotificationsFailedAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SnsNumberOfNotificationsFailedToRedriveToDlqAlarm An alarm that monitors the number of notifications failed to redrive to the dead-letter queue. The alarm is used to detect messages that couldn't be moved to a dead-letter queue. The alarm is triggered when the number of messages failed to redrive to the dead-letter queue is greater than the specified threshold. #### Initializers ```typescript import { SnsNumberOfNotificationsFailedToRedriveToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SnsNumberOfNotificationsFailedToRedriveToDlqAlarm(scope: IConstruct, id: string, props: SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SnsNumberOfNotificationsFailedToRedriveToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedToRedriveToDlqAlarm.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 { SnsNumberOfNotificationsFailedToRedriveToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedToRedriveToDlqAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SnsNumberOfNotificationsFailedToRedriveToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedToRedriveToDlqAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SnsNumberOfNotificationsFailedToRedriveToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedToRedriveToDlqAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SnsNumberOfNotificationsFailedToRedriveToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFailedToRedriveToDlqAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm An alarm that monitors the number of notifications filtered out due to invalid attributes. The alarm is used to detect if the published messages are not valid or if inappropriate filters have been applied to a subscriber. The alarm is triggered when the number of messages filtered out due to invalid attributes is greater than the specified threshold. #### Initializers ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm(scope: IConstruct, id: string, props: SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm.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 { SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm An alarm that monitors the number of notifications filtered out due to invalid message body. The alarm is used to detect if the published messages are not valid or if inappropriate filters have been applied to a subscriber. The alarm is triggered when the number of messages filtered out due to invalid message body is greater than the specified threshold. #### Initializers ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm(scope: IConstruct, id: string, props: SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm.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 { SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SnsNumberOfNotificationsRedrivenToDlqAlarm An alarm that monitors the number of notifications redriven to the dead-letter queue. The alarm is used to detect messages that moved to a dead-letter queue. We recommend that you create this alarm when SNS is coupled with SQS, Lambda or Firehose. The alarm is triggered when the number of messages redriven to the dead-letter queue is greater than the specified threshold. #### Initializers ```typescript import { SnsNumberOfNotificationsRedrivenToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SnsNumberOfNotificationsRedrivenToDlqAlarm(scope: IConstruct, id: string, props: SnsNumberOfNotificationsRedrivenToDlqAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SnsNumberOfNotificationsRedrivenToDlqAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SnsNumberOfNotificationsRedrivenToDlqAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SnsNumberOfNotificationsRedrivenToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsRedrivenToDlqAlarm.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 { SnsNumberOfNotificationsRedrivenToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsRedrivenToDlqAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SnsNumberOfNotificationsRedrivenToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsRedrivenToDlqAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SnsNumberOfNotificationsRedrivenToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsRedrivenToDlqAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SnsNumberOfNotificationsRedrivenToDlqAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsNumberOfNotificationsRedrivenToDlqAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SnsRecommendedAlarms A construct that creates recommended alarms for an SNS topic. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SNS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SNS) #### Initializers ```typescript import { SnsRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SnsRecommendedAlarms(scope: Construct, id: string, props: SnsRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SnsRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SnsRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { SnsRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' SnsRecommendedAlarms.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. | | alarmNumberOfMessagesPublished | SnsNumberOfMessagesPublishedAlarm | The NumberOfMessagesPublished alarm. | | alarmNumberOfNotificationsDelivered | SnsNumberOfNotificationsDeliveredAlarm | The NumberOfNotificationsDelivered alarm. | | alarmNumberOfNotificationsFailed | SnsNumberOfNotificationsFailedAlarm | The NumberOfNotificationsFailed alarm. | | alarmNumberOfNotificationsFailedToRedriveToDlq | SnsNumberOfNotificationsFailedToRedriveToDlqAlarm | The NumberOfNotificationsFailedToRedriveToDlq alarm. | | alarmNumberOfNotificationsFilteredOutInvalidAttributes | SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm | The NumberOfNotificationsFilteredOutInvalidAttributes alarm. | | alarmNumberOfNotificationsFilteredOutInvalidMessageBody | SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm | The NumberOfNotificationsFilteredOutInvalidMessageBody alarm. | | alarmNumberOfNotificationsRedrivenToDlq | SnsNumberOfNotificationsRedrivenToDlqAlarm | The NumberOfNotificationsRedrivenToDlq alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmNumberOfMessagesPublished`^Optional ```typescript public readonly alarmNumberOfMessagesPublished: SnsNumberOfMessagesPublishedAlarm; ``` - *Type:* SnsNumberOfMessagesPublishedAlarm The NumberOfMessagesPublished alarm. --- ##### `alarmNumberOfNotificationsDelivered`^Optional ```typescript public readonly alarmNumberOfNotificationsDelivered: SnsNumberOfNotificationsDeliveredAlarm; ``` - *Type:* SnsNumberOfNotificationsDeliveredAlarm The NumberOfNotificationsDelivered alarm. --- ##### `alarmNumberOfNotificationsFailed`^Optional ```typescript public readonly alarmNumberOfNotificationsFailed: SnsNumberOfNotificationsFailedAlarm; ``` - *Type:* SnsNumberOfNotificationsFailedAlarm The NumberOfNotificationsFailed alarm. --- ##### `alarmNumberOfNotificationsFailedToRedriveToDlq`^Optional ```typescript public readonly alarmNumberOfNotificationsFailedToRedriveToDlq: SnsNumberOfNotificationsFailedToRedriveToDlqAlarm; ``` - *Type:* SnsNumberOfNotificationsFailedToRedriveToDlqAlarm The NumberOfNotificationsFailedToRedriveToDlq alarm. --- ##### `alarmNumberOfNotificationsFilteredOutInvalidAttributes`^Optional ```typescript public readonly alarmNumberOfNotificationsFilteredOutInvalidAttributes: SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm; ``` - *Type:* SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm The NumberOfNotificationsFilteredOutInvalidAttributes alarm. --- ##### `alarmNumberOfNotificationsFilteredOutInvalidMessageBody`^Optional ```typescript public readonly alarmNumberOfNotificationsFilteredOutInvalidMessageBody: SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm; ``` - *Type:* SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm The NumberOfNotificationsFilteredOutInvalidMessageBody alarm. --- ##### `alarmNumberOfNotificationsRedrivenToDlq`^Optional ```typescript public readonly alarmNumberOfNotificationsRedrivenToDlq: SnsNumberOfNotificationsRedrivenToDlqAlarm; ``` - *Type:* SnsNumberOfNotificationsRedrivenToDlqAlarm The NumberOfNotificationsRedrivenToDlq alarm. --- ### SqsApproximateAgeOfOldestMessageAlarm An alarm that watches the age of the oldest message in the queue. This alarm is used to detect whether the age of the oldest message in the QueueName queue is too high. High age can be an indication that messages are not processed quickly enough or that there are some poison-pill messages that are stuck in the queue and can't be processed. This alarm is triggered when the age of the oldest message in the queue exceeds or is equal to the specified threshold. #### Initializers ```typescript import { SqsApproximateAgeOfOldestMessageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SqsApproximateAgeOfOldestMessageAlarm(scope: IConstruct, id: string, props: SqsApproximateAgeOfOldestMessageAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SqsApproximateAgeOfOldestMessageAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SqsApproximateAgeOfOldestMessageAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SqsApproximateAgeOfOldestMessageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateAgeOfOldestMessageAlarm.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 { SqsApproximateAgeOfOldestMessageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateAgeOfOldestMessageAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SqsApproximateAgeOfOldestMessageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateAgeOfOldestMessageAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SqsApproximateAgeOfOldestMessageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateAgeOfOldestMessageAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SqsApproximateAgeOfOldestMessageAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateAgeOfOldestMessageAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SqsApproximateNumberOfMessagesNotVisibleAlarm An alarm that watches the number of messages that are in flight. This alarm is used to detect a high number of in-flight messages in the queue. If consumers do not delete messages within the visibility timeout period, when the queue is polled, messages reappear in the queue. For FIFO queues, there can be a maximum of 20,000 in-flight messages. If you reach this quota, SQS returns no error messages. A FIFO queue looks through the first 20k messages to determine available message groups. This means that if you have a backlog of messages in a single message group, you cannot consume messages from other message groups that were sent to the queue at a later time until you successfully consume the messages from the backlog. This alarm is triggered when the number of messages that are in flight exceeds or is equal to the specified threshold. #### Initializers ```typescript import { SqsApproximateNumberOfMessagesNotVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SqsApproximateNumberOfMessagesNotVisibleAlarm(scope: IConstruct, id: string, props: SqsApproximateNumberOfMessagesNotVisibleAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SqsApproximateNumberOfMessagesNotVisibleAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SqsApproximateNumberOfMessagesNotVisibleAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SqsApproximateNumberOfMessagesNotVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesNotVisibleAlarm.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 { SqsApproximateNumberOfMessagesNotVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesNotVisibleAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SqsApproximateNumberOfMessagesNotVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesNotVisibleAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SqsApproximateNumberOfMessagesNotVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesNotVisibleAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SqsApproximateNumberOfMessagesNotVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesNotVisibleAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SqsApproximateNumberOfMessagesVisibleAlarm An alarm that watches the number of messages that are visible in the queue. This alarm is used to detect whether the message count of the active queue is too high and consumers are slow to process the messages or there are not enough consumers to process them. This alarm is triggered when the number of messages that are visible in the queue exceeds or is equal to the specified threshold. #### Initializers ```typescript import { SqsApproximateNumberOfMessagesVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SqsApproximateNumberOfMessagesVisibleAlarm(scope: IConstruct, id: string, props: SqsApproximateNumberOfMessagesVisibleAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SqsApproximateNumberOfMessagesVisibleAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SqsApproximateNumberOfMessagesVisibleAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SqsApproximateNumberOfMessagesVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesVisibleAlarm.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 { SqsApproximateNumberOfMessagesVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesVisibleAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SqsApproximateNumberOfMessagesVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesVisibleAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SqsApproximateNumberOfMessagesVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesVisibleAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SqsApproximateNumberOfMessagesVisibleAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsApproximateNumberOfMessagesVisibleAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SqsNumberOfMessagesSentAlarm An alarm that watches the number of messages that are sent. This alarm is used to detect when a producer stops sending messages. This alarm is triggered when the number of messages sent is less than or equal to the specified threshold. By default, 0. #### Initializers ```typescript import { SqsNumberOfMessagesSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SqsNumberOfMessagesSentAlarm(scope: IConstruct, id: string, props: SqsNumberOfMessagesSentAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | SqsNumberOfMessagesSentAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SqsNumberOfMessagesSentAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { SqsNumberOfMessagesSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsNumberOfMessagesSentAlarm.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 { SqsNumberOfMessagesSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsNumberOfMessagesSentAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { SqsNumberOfMessagesSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsNumberOfMessagesSentAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { SqsNumberOfMessagesSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsNumberOfMessagesSentAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { SqsNumberOfMessagesSentAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsNumberOfMessagesSentAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### SqsRecommendedAlarms #### Initializers ```typescript import { SqsRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SqsRecommendedAlarms(scope: Construct, id: string, props: SqsRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | SqsRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* SqsRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { SqsRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' SqsRecommendedAlarms.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. | | alarmApproximateAgeOfOldestMessage | SqsApproximateAgeOfOldestMessageAlarm | The approximate age of oldest message alarm. | | alarmApproximateNumberOfMessagesNotVisible | SqsApproximateNumberOfMessagesNotVisibleAlarm | The approximate number of messages not visible alarm. | | alarmApproximateNumberOfMessagesVisible | SqsApproximateNumberOfMessagesVisibleAlarm | The approximate number of messages visible alarm. | | alarmNumberOfMessagesSent | SqsNumberOfMessagesSentAlarm | The number of messages sent alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmApproximateAgeOfOldestMessage`^Optional ```typescript public readonly alarmApproximateAgeOfOldestMessage: SqsApproximateAgeOfOldestMessageAlarm; ``` - *Type:* SqsApproximateAgeOfOldestMessageAlarm The approximate age of oldest message alarm. --- ##### `alarmApproximateNumberOfMessagesNotVisible`^Optional ```typescript public readonly alarmApproximateNumberOfMessagesNotVisible: SqsApproximateNumberOfMessagesNotVisibleAlarm; ``` - *Type:* SqsApproximateNumberOfMessagesNotVisibleAlarm The approximate number of messages not visible alarm. --- ##### `alarmApproximateNumberOfMessagesVisible`^Optional ```typescript public readonly alarmApproximateNumberOfMessagesVisible: SqsApproximateNumberOfMessagesVisibleAlarm; ``` - *Type:* SqsApproximateNumberOfMessagesVisibleAlarm The approximate number of messages visible alarm. --- ##### `alarmNumberOfMessagesSent`^Optional ```typescript public readonly alarmNumberOfMessagesSent: SqsNumberOfMessagesSentAlarm; ``` - *Type:* SqsNumberOfMessagesSentAlarm The number of messages sent alarm. --- ### StateMachine An extension for the StateMachine construct that provides methods to create recommended alarms. #### Initializers ```typescript import { StateMachine } from '@renovosolutions/cdk-library-cloudwatch-alarms' new StateMachine(scope: Construct, id: string, props: StateMachineProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_stepfunctions.StateMachineProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachineProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addToRolePolicy | Add the given statement to the role's policy. | | grant | Grant the given identity custom permissions. | | grantExecution | Grant the given identity permissions on all executions of the state machine. | | grantRead | Grant the given identity permissions to read results from state machine. | | grantRedriveExecution | Grant the given identity permission to redrive the execution of the state machine. | | grantStartExecution | Grant the given identity permissions to start an execution of this state machine. | | grantStartSyncExecution | Grant the given identity permissions to start a synchronous execution of this state machine. | | grantTaskResponse | Grant the given identity task response permissions on a state machine. | | metric | Return the given named metric for this State Machine's executions. | | metricAborted | Metric for the number of executions that were aborted. | | metricFailed | Metric for the number of executions that failed. | | metricStarted | Metric for the number of executions that were started. | | metricSucceeded | Metric for the number of executions that succeeded. | | metricThrottled | Metric for the number of executions that were throttled. | | metricTime | Metric for the interval, in milliseconds, between the time the execution starts and the time it closes. | | metricTimedOut | Metric for the number of executions that timed out. | | alarmExecutionsFailed | Creates an alarm that monitors the ExecutionsFailed for the StepFunctions stateMachine. | | alarmExecutionsTimedOut | Creates an alarm that monitors the ExecutionsTimedOut for the StepFunctions stateMachine. | | alarmExecutionThrottled | Creates an alarm that monitors the ExecutionThrottled for the StepFunctions stateMachine. | | alarmExecutionTime | Creates an alarm that monitors the ExecutionTime for the StepFunctions stateMachine. | | applyRecommendedAlarms | Creates the recommended alarms for the StepFunctions StateMachine. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addToRolePolicy` ```typescript public addToRolePolicy(statement: PolicyStatement): void ``` Add the given statement to the role's policy. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement --- ##### `grant` ```typescript public grant(identity: IGrantable, actions: ...string[]): Grant ``` Grant the given identity custom permissions. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `actions`^Required - *Type:* ...string[] --- ##### `grantExecution` ```typescript public grantExecution(identity: IGrantable, actions: ...string[]): Grant ``` Grant the given identity permissions on all executions of the state machine. The use of this method is discouraged. Please use `grants.execution()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `actions`^Required - *Type:* ...string[] --- ##### `grantRead` ```typescript public grantRead(identity: IGrantable): Grant ``` Grant the given identity permissions to read results from state machine. The use of this method is discouraged. Please use `grants.read()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `grantRedriveExecution` ```typescript public grantRedriveExecution(identity: IGrantable): Grant ``` Grant the given identity permission to redrive the execution of the state machine. The use of this method is discouraged. Please use `grants.redriveExecution()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `grantStartExecution` ```typescript public grantStartExecution(identity: IGrantable): Grant ``` Grant the given identity permissions to start an execution of this state machine. The use of this method is discouraged. Please use `grants.startExecution()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `grantStartSyncExecution` ```typescript public grantStartSyncExecution(identity: IGrantable): Grant ``` Grant the given identity permissions to start a synchronous execution of this state machine. The use of this method is discouraged. Please use `grants.startSyncExecution()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `grantTaskResponse` ```typescript public grantTaskResponse(identity: IGrantable): Grant ``` Grant the given identity task response permissions on a state machine. The use of this method is discouraged. Please use `grants.taskResponse()` instead. [disable-awslint:no-grants] ###### `identity`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this State Machine's executions. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricAborted` ```typescript public metricAborted(props?: MetricOptions): Metric ``` Metric for the number of executions that were aborted. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricFailed` ```typescript public metricFailed(props?: MetricOptions): Metric ``` Metric for the number of executions that failed. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricStarted` ```typescript public metricStarted(props?: MetricOptions): Metric ``` Metric for the number of executions that were started. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSucceeded` ```typescript public metricSucceeded(props?: MetricOptions): Metric ``` Metric for the number of executions that succeeded. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricThrottled` ```typescript public metricThrottled(props?: MetricOptions): Metric ``` Metric for the number of executions that were throttled. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTime` ```typescript public metricTime(props?: MetricOptions): Metric ``` Metric for the interval, in milliseconds, between the time the execution starts and the time it closes. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricTimedOut` ```typescript public metricTimedOut(props?: MetricOptions): Metric ``` Metric for the number of executions that timed out. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `alarmExecutionsFailed` ```typescript public alarmExecutionsFailed(props?: SfStateMachineExecutionsFailedAlarmConfig): SfStateMachineExecutionsFailedAlarm ``` Creates an alarm that monitors the ExecutionsFailed for the StepFunctions stateMachine. ###### `props`^Optional - *Type:* SfStateMachineExecutionsFailedAlarmConfig --- ##### `alarmExecutionsTimedOut` ```typescript public alarmExecutionsTimedOut(props?: SfStateMachineExecutionsTimedOutAlarmConfig): SfStateMachineExecutionsTimedOutAlarm ``` Creates an alarm that monitors the ExecutionsTimedOut for the StepFunctions stateMachine. ###### `props`^Optional - *Type:* SfStateMachineExecutionsTimedOutAlarmConfig --- ##### `alarmExecutionThrottled` ```typescript public alarmExecutionThrottled(props?: SfStateMachineExecutionThrottledAlarmConfig): SfStateMachineExecutionThrottledAlarm ``` Creates an alarm that monitors the ExecutionThrottled for the StepFunctions stateMachine. ###### `props`^Optional - *Type:* SfStateMachineExecutionThrottledAlarmConfig --- ##### `alarmExecutionTime` ```typescript public alarmExecutionTime(props: SfStateMachineExecutionTimeAlarmConfig): SfStateMachineExecutionTimeAlarm ``` Creates an alarm that monitors the ExecutionTime for the StepFunctions stateMachine. ###### `props`^Required - *Type:* SfStateMachineExecutionTimeAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: SfStateMachineRecommendedAlarmsConfig): SfStateMachineRecommendedAlarms ``` Creates the recommended alarms for the StepFunctions StateMachine. ###### `props`^Required - *Type:* SfStateMachineRecommendedAlarmsConfig --- #### 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. | | fromStateMachineArn | Import a state machine. | | fromStateMachineName | Import a state machine via resource name. | --- ##### `isConstruct` ```typescript import { StateMachine } from '@renovosolutions/cdk-library-cloudwatch-alarms' StateMachine.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 { StateMachine } from '@renovosolutions/cdk-library-cloudwatch-alarms' StateMachine.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { StateMachine } from '@renovosolutions/cdk-library-cloudwatch-alarms' StateMachine.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromStateMachineArn` ```typescript import { StateMachine } from '@renovosolutions/cdk-library-cloudwatch-alarms' StateMachine.fromStateMachineArn(scope: Construct, id: string, stateMachineArn: string) ``` Import a state machine. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `stateMachineArn`^Required - *Type:* string --- ##### `fromStateMachineName` ```typescript import { StateMachine } from '@renovosolutions/cdk-library-cloudwatch-alarms' StateMachine.fromStateMachineName(scope: Construct, id: string, stateMachineName: string) ``` Import a state machine via resource name. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `stateMachineName`^Required - *Type:* string --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | grantPrincipal | aws-cdk-lib.aws_iam.IPrincipal | The principal this state machine is running as. | | role | aws-cdk-lib.aws_iam.IRole | Execution role of this state machine. | | stateMachineArn | string | The ARN of the state machine. | | stateMachineName | string | The name of the state machine. | | stateMachineRef | aws-cdk-lib.interfaces.aws_stepfunctions.StateMachineReference | A reference to a StateMachine resource. | | stateMachineRevisionId | string | Identifier for the state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration. | | stateMachineType | aws-cdk-lib.aws_stepfunctions.StateMachineType | Type of the state machine. | | grants | aws-cdk-lib.aws_stepfunctions.StateMachineGrants | Collection of grant methods for a StateMachine. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `grantPrincipal`^Required ```typescript public readonly grantPrincipal: IPrincipal; ``` - *Type:* aws-cdk-lib.aws_iam.IPrincipal The principal this state machine is running as. --- ##### `role`^Required ```typescript public readonly role: IRole; ``` - *Type:* aws-cdk-lib.aws_iam.IRole Execution role of this state machine. --- ##### `stateMachineArn`^Required ```typescript public readonly stateMachineArn: string; ``` - *Type:* string The ARN of the state machine. --- ##### `stateMachineName`^Required ```typescript public readonly stateMachineName: string; ``` - *Type:* string The name of the state machine. --- ##### `stateMachineRef`^Required ```typescript public readonly stateMachineRef: StateMachineReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_stepfunctions.StateMachineReference A reference to a StateMachine resource. --- ##### `stateMachineRevisionId`^Required ```typescript public readonly stateMachineRevisionId: string; ``` - *Type:* string Identifier for the state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration. --- ##### `stateMachineType`^Required ```typescript public readonly stateMachineType: StateMachineType; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachineType Type of the state machine. --- ##### `grants`^Required ```typescript public readonly grants: StateMachineGrants; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachineGrants Collection of grant methods for a StateMachine. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### Table An extension for the Table construct that provides methods to create recommended alarms. #### Initializers ```typescript import { Table } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Table(scope: Construct, id: string, props: TableProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_dynamodb.TableProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_dynamodb.TableProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addToResourcePolicy | Adds a statement to the resource policy associated with this table. | | grant | Adds an IAM policy statement associated with this table to an IAM principal's policy. | | grantFullAccess | Permits all DynamoDB operations ("dynamodb:*") to an IAM principal. | | grantOnKey | Gives permissions to a grantable entity to perform actions on the encryption key. | | grantReadData | Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, DescribeTable. | | grantReadWriteData | Permits an IAM principal to all data read/write operations to this table. | | grantStream | Adds an IAM policy statement associated with this table's stream to an IAM principal's policy. | | grantStreamRead | Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams. | | grantTableListStreams | Permits an IAM Principal to list streams attached to current dynamodb table. | | grantWriteData | Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem, DescribeTable. | | metric | Return the given named metric for this Table. | | metricConditionalCheckFailedRequests | Metric for the conditional check failed requests this table. | | metricConsumedReadCapacityUnits | Metric for the consumed read capacity units this table. | | metricConsumedWriteCapacityUnits | Metric for the consumed write capacity units this table. | | metricSuccessfulRequestLatency | Metric for the successful request latency this table. | | metricSystemErrors | Metric for the system errors this table. | | metricSystemErrorsForOperations | Metric for the system errors this table. | | metricThrottledRequests | How many requests are throttled on this table. | | metricThrottledRequestsForOperation | How many requests are throttled on this table, for the given operation. | | metricThrottledRequestsForOperations | How many requests are throttled on this table. | | metricUserErrors | Metric for the user errors. | | addGlobalSecondaryIndex | Add a global secondary index of table. | | addLocalSecondaryIndex | Add a local secondary index of table. | | autoScaleGlobalSecondaryIndexReadCapacity | Enable read capacity scaling for the given GSI. | | autoScaleGlobalSecondaryIndexWriteCapacity | Enable write capacity scaling for the given GSI. | | autoScaleReadCapacity | Enable read capacity scaling for this table. | | autoScaleWriteCapacity | Enable write capacity scaling for this table. | | schema | Get schema attributes of table or index. | | schemaV2 | Get schema attributes of table or index. | | alarmAgeOfOldestUnreplicatedRecord | Creates an alarm that monitors the AgeOfOldestUnreplicatedRecord for the DynamoDb table. | | alarmFailedToReplicateRecordCount | Creates an alarm that monitors the FailedToReplicateRecordCount for the DynamoDb table. | | alarmReadThrottleEvents | Creates an alarm that monitors the ReadThrottleEvents for the DynamoDb table. | | alarmSystemErrors | Creates an alarm that monitors the SystemErrors for the DynamoDb table. | | alarmThrottledPutRecordCount | Creates an alarm that monitors the ThrottledPutRecordCount for the DynamoDb table. | | alarmWriteThrottleEvents | Creates an alarm that monitors the WriteThrottleEvents for the DynamoDb table. | | applyRecommendedAlarms | Creates the recommended alarms for the DynamoDb Table. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the resource policy associated with this table. A resource policy will be automatically created upon the first call to `addToResourcePolicy`. Note that this does not work with imported tables. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement The policy statement to add. --- ##### `grant` ```typescript public grant(grantee: IGrantable, actions: ...string[]): Grant ``` Adds an IAM policy statement associated with this table to an IAM principal's policy. If `encryptionKey` is present, appropriate grants to the key needs to be added separately using the `table.encryptionKey.grant*` methods. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal (no-op if undefined). --- ###### `actions`^Required - *Type:* ...string[] The set of actions to allow (i.e. "dynamodb:PutItem", "dynamodb:GetItem", ...). --- ##### `grantFullAccess` ```typescript public grantFullAccess(grantee: IGrantable): Grant ``` Permits all DynamoDB operations ("dynamodb:*") to an IAM principal. Appropriate grants will also be added to the customer-managed KMS key if one was configured. The use of this method is discouraged. Please use `grants.fullAccess()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant access to. --- ##### `grantOnKey` ```typescript public grantOnKey(grantee: IGrantable, actions: ...string[]): GrantOnKeyResult ``` Gives permissions to a grantable entity to perform actions on the encryption key. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `actions`^Required - *Type:* ...string[] --- ##### `grantReadData` ```typescript public grantReadData(grantee: IGrantable): Grant ``` Permits an IAM principal all data read operations from this table: BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, DescribeTable. Appropriate grants will also be added to the customer-managed KMS key if one was configured. The use of this method is discouraged. Please use `grants.readData()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant access to. --- ##### `grantReadWriteData` ```typescript public grantReadWriteData(grantee: IGrantable): Grant ``` Permits an IAM principal to all data read/write operations to this table. BatchGetItem, GetRecords, GetShardIterator, Query, GetItem, Scan, BatchWriteItem, PutItem, UpdateItem, DeleteItem, DescribeTable Appropriate grants will also be added to the customer-managed KMS key if one was configured. The use of this method is discouraged. Please use `grants.readWriteData()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant access to. --- ##### `grantStream` ```typescript public grantStream(grantee: IGrantable, actions: ...string[]): Grant ``` Adds an IAM policy statement associated with this table's stream to an IAM principal's policy. If `encryptionKey` is present, appropriate grants to the key needs to be added separately using the `table.encryptionKey.grant*` methods. The use of this method is discouraged. Please use `streamGrants.stream()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal (no-op if undefined). --- ###### `actions`^Required - *Type:* ...string[] The set of actions to allow (i.e. "dynamodb:DescribeStream", "dynamodb:GetRecords", ...). --- ##### `grantStreamRead` ```typescript public grantStreamRead(grantee: IGrantable): Grant ``` Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams. Appropriate grants will also be added to the customer-managed KMS key if one was configured. The use of this method is discouraged. Please use `streamGrants.streamRead()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant access to. --- ##### `grantTableListStreams` ```typescript public grantTableListStreams(grantee: IGrantable): Grant ``` Permits an IAM Principal to list streams attached to current dynamodb table. The use of this method is discouraged. Please use `streamGrants.tableListStreams()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal (no-op if undefined). --- ##### `grantWriteData` ```typescript public grantWriteData(grantee: IGrantable): Grant ``` Permits an IAM principal all data write operations to this table: BatchWriteItem, PutItem, UpdateItem, DeleteItem, DescribeTable. Appropriate grants will also be added to the customer-managed KMS key if one was configured. The use of this method is discouraged. Please use `grants.writeData()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable The principal to grant access to. --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Table. By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the `statistic` and `period` properties. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConditionalCheckFailedRequests` ```typescript public metricConditionalCheckFailedRequests(props?: MetricOptions): Metric ``` Metric for the conditional check failed requests this table. By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the `statistic` and `period` properties. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumedReadCapacityUnits` ```typescript public metricConsumedReadCapacityUnits(props?: MetricOptions): Metric ``` Metric for the consumed read capacity units this table. By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the `statistic` and `period` properties. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricConsumedWriteCapacityUnits` ```typescript public metricConsumedWriteCapacityUnits(props?: MetricOptions): Metric ``` Metric for the consumed write capacity units this table. By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the `statistic` and `period` properties. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSuccessfulRequestLatency` ```typescript public metricSuccessfulRequestLatency(props?: MetricOptions): Metric ``` Metric for the successful request latency this table. By default, the metric will be calculated as an average over a period of 5 minutes. You can customize this by using the `statistic` and `period` properties. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### ~~`metricSystemErrors`~~ ```typescript public metricSystemErrors(props?: MetricOptions): Metric ``` Metric for the system errors this table. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSystemErrorsForOperations` ```typescript public metricSystemErrorsForOperations(props?: SystemErrorsForOperationsMetricOptions): IMetric ``` Metric for the system errors this table. This will sum errors across all possible operations. Note that by default, each individual metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the `statistic` and `period` properties. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_dynamodb.SystemErrorsForOperationsMetricOptions --- ##### ~~`metricThrottledRequests`~~ ```typescript public metricThrottledRequests(props?: MetricOptions): Metric ``` How many requests are throttled on this table. Default: sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricThrottledRequestsForOperation` ```typescript public metricThrottledRequestsForOperation(operation: string, props?: MetricOptions): Metric ``` How many requests are throttled on this table, for the given operation. Default: sum over 5 minutes ###### `operation`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricThrottledRequestsForOperations` ```typescript public metricThrottledRequestsForOperations(props?: OperationsMetricOptions): IMetric ``` How many requests are throttled on this table. This will sum errors across all possible operations. Note that by default, each individual metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the `statistic` and `period` properties. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_dynamodb.OperationsMetricOptions --- ##### `metricUserErrors` ```typescript public metricUserErrors(props?: MetricOptions): Metric ``` Metric for the user errors. Note that this metric reports user errors across all the tables in the account and region the table resides in. By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the `statistic` and `period` properties. ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `addGlobalSecondaryIndex` ```typescript public addGlobalSecondaryIndex(props: GlobalSecondaryIndexProps): void ``` Add a global secondary index of table. ###### `props`^Required - *Type:* aws-cdk-lib.aws_dynamodb.GlobalSecondaryIndexProps the property of global secondary index. --- ##### `addLocalSecondaryIndex` ```typescript public addLocalSecondaryIndex(props: LocalSecondaryIndexProps): void ``` Add a local secondary index of table. ###### `props`^Required - *Type:* aws-cdk-lib.aws_dynamodb.LocalSecondaryIndexProps the property of local secondary index. --- ##### `autoScaleGlobalSecondaryIndexReadCapacity` ```typescript public autoScaleGlobalSecondaryIndexReadCapacity(indexName: string, props: EnableScalingProps): IScalableTableAttribute ``` Enable read capacity scaling for the given GSI. ###### `indexName`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_dynamodb.EnableScalingProps --- ##### `autoScaleGlobalSecondaryIndexWriteCapacity` ```typescript public autoScaleGlobalSecondaryIndexWriteCapacity(indexName: string, props: EnableScalingProps): IScalableTableAttribute ``` Enable write capacity scaling for the given GSI. ###### `indexName`^Required - *Type:* string --- ###### `props`^Required - *Type:* aws-cdk-lib.aws_dynamodb.EnableScalingProps --- ##### `autoScaleReadCapacity` ```typescript public autoScaleReadCapacity(props: EnableScalingProps): IScalableTableAttribute ``` Enable read capacity scaling for this table. ###### `props`^Required - *Type:* aws-cdk-lib.aws_dynamodb.EnableScalingProps --- ##### `autoScaleWriteCapacity` ```typescript public autoScaleWriteCapacity(props: EnableScalingProps): IScalableTableAttribute ``` Enable write capacity scaling for this table. ###### `props`^Required - *Type:* aws-cdk-lib.aws_dynamodb.EnableScalingProps --- ##### ~~`schema`~~ ```typescript public schema(indexName?: string): SchemaOptions ``` Get schema attributes of table or index. ###### `indexName`^Optional - *Type:* string --- ##### `schemaV2` ```typescript public schemaV2(indexName?: string): KeySchema ``` Get schema attributes of table or index. ###### `indexName`^Optional - *Type:* string --- ##### `alarmAgeOfOldestUnreplicatedRecord` ```typescript public alarmAgeOfOldestUnreplicatedRecord(props: DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig): DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm ``` Creates an alarm that monitors the AgeOfOldestUnreplicatedRecord for the DynamoDb table. ###### `props`^Required - *Type:* DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig --- ##### `alarmFailedToReplicateRecordCount` ```typescript public alarmFailedToReplicateRecordCount(props: DynamoDbFailedToReplicateRecordCountAlarmConfig): DynamoDbTableFailedToReplicateRecordCountAlarm ``` Creates an alarm that monitors the FailedToReplicateRecordCount for the DynamoDb table. ###### `props`^Required - *Type:* DynamoDbFailedToReplicateRecordCountAlarmConfig --- ##### `alarmReadThrottleEvents` ```typescript public alarmReadThrottleEvents(props: DynamoDbReadThrottleEventsAlarmConfig): DynamoDbTableReadThrottleEventsAlarm ``` Creates an alarm that monitors the ReadThrottleEvents for the DynamoDb table. ###### `props`^Required - *Type:* DynamoDbReadThrottleEventsAlarmConfig --- ##### `alarmSystemErrors` ```typescript public alarmSystemErrors(props: DynamoDbSystemErrorsAlarmConfig): DynamoDbTableSystemErrorsAlarm ``` Creates an alarm that monitors the SystemErrors for the DynamoDb table. ###### `props`^Required - *Type:* DynamoDbSystemErrorsAlarmConfig --- ##### `alarmThrottledPutRecordCount` ```typescript public alarmThrottledPutRecordCount(props: DynamoDbThrottledPutRecordCountAlarmConfig): DynamoDbTableThrottledPutRecordCountAlarm ``` Creates an alarm that monitors the ThrottledPutRecordCount for the DynamoDb table. ###### `props`^Required - *Type:* DynamoDbThrottledPutRecordCountAlarmConfig --- ##### `alarmWriteThrottleEvents` ```typescript public alarmWriteThrottleEvents(props: DynamoDbWriteThrottleEventsAlarmConfig): DynamoDbTableWriteThrottleEventsAlarm ``` Creates an alarm that monitors the WriteThrottleEvents for the DynamoDb table. ###### `props`^Required - *Type:* DynamoDbWriteThrottleEventsAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: DynamoDbTableRecommendedAlarmsConfig): DynamoDbTableRecommendedAlarms ``` Creates the recommended alarms for the DynamoDb Table. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#DynamoDB](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#DynamoDB) ###### `props`^Required - *Type:* DynamoDbTableRecommendedAlarmsConfig --- #### 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. | | fromTableArn | Creates a Table construct that represents an external table via table arn. | | fromTableAttributes | Creates a Table construct that represents an external table. | | fromTableName | Creates a Table construct that represents an external table via table name. | --- ##### `isConstruct` ```typescript import { Table } from '@renovosolutions/cdk-library-cloudwatch-alarms' Table.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 { Table } from '@renovosolutions/cdk-library-cloudwatch-alarms' Table.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Table } from '@renovosolutions/cdk-library-cloudwatch-alarms' Table.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromTableArn` ```typescript import { Table } from '@renovosolutions/cdk-library-cloudwatch-alarms' Table.fromTableArn(scope: Construct, id: string, tableArn: string) ``` Creates a Table construct that represents an external table via table arn. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `tableArn`^Required - *Type:* string The table's ARN. --- ##### `fromTableAttributes` ```typescript import { Table } from '@renovosolutions/cdk-library-cloudwatch-alarms' Table.fromTableAttributes(scope: Construct, id: string, attrs: TableAttributes) ``` Creates a Table construct that represents an external table. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_dynamodb.TableAttributes A `TableAttributes` object. --- ##### `fromTableName` ```typescript import { Table } from '@renovosolutions/cdk-library-cloudwatch-alarms' Table.fromTableName(scope: Construct, id: string, tableName: string) ``` Creates a Table construct that represents an external table via table name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `tableName`^Required - *Type:* string The table's name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | grants | aws-cdk-lib.aws_dynamodb.TableGrants | Grant a predefined set of permissions on this Table. | | streamGrants | aws-cdk-lib.aws_dynamodb.StreamGrants | Grant a predefined set of permissions on this Table's Stream, if present. | | tableArn | string | Arn of the dynamodb table. | | tableName | string | Table name of the dynamodb table. | | tableRef | aws-cdk-lib.interfaces.aws_dynamodb.TableReference | A reference to a Table resource. | | encryptionKey | aws-cdk-lib.aws_kms.IKey | KMS encryption key, if this table uses a customer-managed encryption key. | | regions | string[] | Additional regions other than the main one that this table is replicated to. | | tableStreamArn | string | ARN of the table's stream, if there is one. | | resourcePolicy | aws-cdk-lib.aws_iam.PolicyDocument | Resource policy to assign to DynamoDB Table. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `grants`^Required ```typescript public readonly grants: TableGrants; ``` - *Type:* aws-cdk-lib.aws_dynamodb.TableGrants Grant a predefined set of permissions on this Table. --- ##### `streamGrants`^Required ```typescript public readonly streamGrants: StreamGrants; ``` - *Type:* aws-cdk-lib.aws_dynamodb.StreamGrants Grant a predefined set of permissions on this Table's Stream, if present. Will throw if the Table has not been configured for streaming. --- ##### `tableArn`^Required ```typescript public readonly tableArn: string; ``` - *Type:* string Arn of the dynamodb table. --- ##### `tableName`^Required ```typescript public readonly tableName: string; ``` - *Type:* string Table name of the dynamodb table. --- ##### `tableRef`^Required ```typescript public readonly tableRef: TableReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_dynamodb.TableReference A reference to a Table resource. --- ##### `encryptionKey`^Optional ```typescript public readonly encryptionKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey KMS encryption key, if this table uses a customer-managed encryption key. --- ##### `regions`^Optional ```typescript public readonly regions: string[]; ``` - *Type:* string[] Additional regions other than the main one that this table is replicated to. --- ##### `tableStreamArn`^Optional ```typescript public readonly tableStreamArn: string; ``` - *Type:* string ARN of the table's stream, if there is one. --- ##### `resourcePolicy`^Optional ```typescript public readonly resourcePolicy: PolicyDocument; ``` - *Type:* aws-cdk-lib.aws_iam.PolicyDocument - *Default:* No resource policy statements are added to the created table. Resource policy to assign to DynamoDB Table. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-resourcepolicy.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-resourcepolicy.html) --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### Topic An extension of the SNS topic construct that provides helper methods to create recommended alarms. #### Initializers ```typescript import { Topic } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Topic(scope: Construct, id: string, props?: TopicProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_sns.TopicProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Optional - *Type:* aws-cdk-lib.aws_sns.TopicProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addSubscription | Subscribe some endpoint to this topic. | | addToResourcePolicy | Adds a statement to the IAM resource policy associated with this topic. | | bindAsNotificationRuleTarget | Represents a notification target That allows SNS topic to associate with this rule target. | | grantOnKey | Gives permissions to a grantable entity to perform actions on the encryption key. | | grantPublish | Grant topic publishing permissions to the given identity. | | grantSubscribe | Grant topic subscribing permissions to the given identity. | | metric | Return the given named metric for this Topic. | | metricNumberOfMessagesPublished | The number of messages published to your Amazon SNS topics. | | metricNumberOfNotificationsDelivered | The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints. | | metricNumberOfNotificationsFailed | The number of messages that Amazon SNS failed to deliver. | | metricNumberOfNotificationsFilteredOut | The number of messages that were rejected by subscription filter policies. | | metricNumberOfNotificationsFilteredOutInvalidAttributes | The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid. | | metricNumberOfNotificationsFilteredOutNoMessageAttributes | The number of messages that were rejected by subscription filter policies because the messages have no attributes. | | metricPublishSize | Metric for the size of messages published through this topic. | | metricSMSMonthToDateSpentUSD | The charges you have accrued since the start of the current calendar month for sending SMS messages. | | metricSMSSuccessRate | The rate of successful SMS message deliveries. | | addLoggingConfig | Adds a delivery status logging configuration to the topic. | | alarmNumberOfMessagesPublished | Creates an alarm for the NumberOfMessagesPublished metric. | | alarmNumberOfNotificationsDelivered | Creates an alarm for the NumberOfNotificationsDelivered metric. | | alarmNumberOfNotificationsFailed | Creates an alarm for the NumberOfNotificationsFailed metric. | | alarmNumberOfNotificationsFailedToRedriveToDlq | Creates an alarm for the NumberOfNotificationsFailedToRedriveToDlq metric. | | alarmNumberOfNotificationsFilteredOutInvalidAttributes | Creates an alarm for the NumberOfNotificationsFilteredOutInvalidAttributes metric. | | alarmNumberOfNotificationsFilteredOutInvalidMessageBody | Creates an alarm for the NumberOfNotificationsFilteredOutInvalidMessageBody metric. | | alarmNumberOfNotificationsRedrivenToDlq | Creates an alarm for the NumberOfNotificationsRedrivenToDlq metric. | | applyRecommendedAlarms | Creates recommended alarms for the SNS topic. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addSubscription` ```typescript public addSubscription(topicSubscription: ITopicSubscription): Subscription ``` Subscribe some endpoint to this topic. ###### `topicSubscription`^Required - *Type:* aws-cdk-lib.aws_sns.ITopicSubscription --- ##### `addToResourcePolicy` ```typescript public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult ``` Adds a statement to the IAM resource policy associated with this topic. If this topic was created in this stack (`new Topic`), a topic policy will be automatically created upon the first call to `addToResourcePolicy`. However, if `enforceSSL` is set to `true`, the policy has already been created before the first call to this method. If the topic is imported (`Topic.import`), then this is a no-op. ###### `statement`^Required - *Type:* aws-cdk-lib.aws_iam.PolicyStatement --- ##### `bindAsNotificationRuleTarget` ```typescript public bindAsNotificationRuleTarget(_scope: Construct): NotificationRuleTargetConfig ``` Represents a notification target That allows SNS topic to associate with this rule target. ###### `_scope`^Required - *Type:* constructs.Construct --- ##### `grantOnKey` ```typescript public grantOnKey(grantee: IGrantable, actions: ...string[]): GrantOnKeyResult ``` Gives permissions to a grantable entity to perform actions on the encryption key. ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ###### `actions`^Required - *Type:* ...string[] --- ##### `grantPublish` ```typescript public grantPublish(grantee: IGrantable): Grant ``` Grant topic publishing permissions to the given identity. The use of this method is discouraged. Please use `grants.publish()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `grantSubscribe` ```typescript public grantSubscribe(grantee: IGrantable): Grant ``` Grant topic subscribing permissions to the given identity. The use of this method is discouraged. Please use `grants.subscribe()` instead. [disable-awslint:no-grants] ###### `grantee`^Required - *Type:* aws-cdk-lib.aws_iam.IGrantable --- ##### `metric` ```typescript public metric(metricName: string, props?: MetricOptions): Metric ``` Return the given named metric for this Topic. ###### `metricName`^Required - *Type:* string --- ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfMessagesPublished` ```typescript public metricNumberOfMessagesPublished(props?: MetricOptions): Metric ``` The number of messages published to your Amazon SNS topics. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfNotificationsDelivered` ```typescript public metricNumberOfNotificationsDelivered(props?: MetricOptions): Metric ``` The number of messages successfully delivered from your Amazon SNS topics to subscribing endpoints. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfNotificationsFailed` ```typescript public metricNumberOfNotificationsFailed(props?: MetricOptions): Metric ``` The number of messages that Amazon SNS failed to deliver. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfNotificationsFilteredOut` ```typescript public metricNumberOfNotificationsFilteredOut(props?: MetricOptions): Metric ``` The number of messages that were rejected by subscription filter policies. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfNotificationsFilteredOutInvalidAttributes` ```typescript public metricNumberOfNotificationsFilteredOutInvalidAttributes(props?: MetricOptions): Metric ``` The number of messages that were rejected by subscription filter policies because the messages' attributes are invalid. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricNumberOfNotificationsFilteredOutNoMessageAttributes` ```typescript public metricNumberOfNotificationsFilteredOutNoMessageAttributes(props?: MetricOptions): Metric ``` The number of messages that were rejected by subscription filter policies because the messages have no attributes. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricPublishSize` ```typescript public metricPublishSize(props?: MetricOptions): Metric ``` Metric for the size of messages published through this topic. Average over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSMSMonthToDateSpentUSD` ```typescript public metricSMSMonthToDateSpentUSD(props?: MetricOptions): Metric ``` The charges you have accrued since the start of the current calendar month for sending SMS messages. Maximum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `metricSMSSuccessRate` ```typescript public metricSMSSuccessRate(props?: MetricOptions): Metric ``` The rate of successful SMS message deliveries. Sum over 5 minutes ###### `props`^Optional - *Type:* aws-cdk-lib.aws_cloudwatch.MetricOptions --- ##### `addLoggingConfig` ```typescript public addLoggingConfig(config: LoggingConfig): void ``` Adds a delivery status logging configuration to the topic. ###### `config`^Required - *Type:* aws-cdk-lib.aws_sns.LoggingConfig --- ##### `alarmNumberOfMessagesPublished` ```typescript public alarmNumberOfMessagesPublished(props: SnsNumberOfMessagesPublishedAlarmConfig): SnsNumberOfMessagesPublishedAlarm ``` Creates an alarm for the NumberOfMessagesPublished metric. ###### `props`^Required - *Type:* SnsNumberOfMessagesPublishedAlarmConfig --- ##### `alarmNumberOfNotificationsDelivered` ```typescript public alarmNumberOfNotificationsDelivered(props: SnsNumberOfNotificationsDeliveredAlarmConfig): SnsNumberOfNotificationsDeliveredAlarm ``` Creates an alarm for the NumberOfNotificationsDelivered metric. ###### `props`^Required - *Type:* SnsNumberOfNotificationsDeliveredAlarmConfig --- ##### `alarmNumberOfNotificationsFailed` ```typescript public alarmNumberOfNotificationsFailed(props: SnsNumberOfNotificationsFailedAlarmConfig): SnsNumberOfNotificationsFailedAlarm ``` Creates an alarm for the NumberOfNotificationsFailed metric. ###### `props`^Required - *Type:* SnsNumberOfNotificationsFailedAlarmConfig --- ##### `alarmNumberOfNotificationsFailedToRedriveToDlq` ```typescript public alarmNumberOfNotificationsFailedToRedriveToDlq(props?: SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig): SnsNumberOfNotificationsFailedToRedriveToDlqAlarm ``` Creates an alarm for the NumberOfNotificationsFailedToRedriveToDlq metric. ###### `props`^Optional - *Type:* SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig --- ##### `alarmNumberOfNotificationsFilteredOutInvalidAttributes` ```typescript public alarmNumberOfNotificationsFilteredOutInvalidAttributes(props?: SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig): SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm ``` Creates an alarm for the NumberOfNotificationsFilteredOutInvalidAttributes metric. ###### `props`^Optional - *Type:* SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig --- ##### `alarmNumberOfNotificationsFilteredOutInvalidMessageBody` ```typescript public alarmNumberOfNotificationsFilteredOutInvalidMessageBody(props?: SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig): SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm ``` Creates an alarm for the NumberOfNotificationsFilteredOutInvalidMessageBody metric. ###### `props`^Optional - *Type:* SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig --- ##### `alarmNumberOfNotificationsRedrivenToDlq` ```typescript public alarmNumberOfNotificationsRedrivenToDlq(props?: SnsNumberOfNotificationsRedrivenToDlqAlarmConfig): SnsNumberOfNotificationsRedrivenToDlqAlarm ``` Creates an alarm for the NumberOfNotificationsRedrivenToDlq metric. ###### `props`^Optional - *Type:* SnsNumberOfNotificationsRedrivenToDlqAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: SnsRecommendedAlarmsConfig): SnsRecommendedAlarms ``` Creates recommended alarms for the SNS topic. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SNS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SNS) ###### `props`^Required - *Type:* SnsRecommendedAlarmsConfig --- #### 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. | | fromTopicArn | Import an existing SNS topic provided an ARN. | | fromTopicAttributes | Import an existing SNS topic provided a topic attributes. | --- ##### `isConstruct` ```typescript import { Topic } from '@renovosolutions/cdk-library-cloudwatch-alarms' Topic.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 { Topic } from '@renovosolutions/cdk-library-cloudwatch-alarms' Topic.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { Topic } from '@renovosolutions/cdk-library-cloudwatch-alarms' Topic.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromTopicArn` ```typescript import { Topic } from '@renovosolutions/cdk-library-cloudwatch-alarms' Topic.fromTopicArn(scope: Construct, id: string, topicArn: string) ``` Import an existing SNS topic provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct. --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `topicArn`^Required - *Type:* string topic ARN (i.e. arn:aws:sns:us-east-2:444455556666:MyTopic). --- ##### `fromTopicAttributes` ```typescript import { Topic } from '@renovosolutions/cdk-library-cloudwatch-alarms' Topic.fromTopicAttributes(scope: Construct, id: string, attrs: TopicAttributes) ``` Import an existing SNS topic provided a topic attributes. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct. --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `attrs`^Required - *Type:* aws-cdk-lib.aws_sns.TopicAttributes the attributes of the topic to import. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | contentBasedDeduplication | boolean | Enables content-based deduplication for FIFO topics. | | fifo | boolean | Whether this topic is an Amazon SNS FIFO queue. | | grants | aws-cdk-lib.aws_sns.TopicGrants | Collection of grant methods for a Topic. | | topicArn | string | The ARN of the topic. | | topicName | string | The name of the topic. | | topicRef | aws-cdk-lib.interfaces.aws_sns.TopicReference | A reference to a Topic resource. | | masterKey | aws-cdk-lib.aws_kms.IKey | A KMS Key, either managed by this CDK app, or imported. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `contentBasedDeduplication`^Required ```typescript public readonly contentBasedDeduplication: boolean; ``` - *Type:* boolean Enables content-based deduplication for FIFO topics. --- ##### `fifo`^Required ```typescript public readonly fifo: boolean; ``` - *Type:* boolean Whether this topic is an Amazon SNS FIFO queue. If false, this is a standard topic. --- ##### `grants`^Required ```typescript public readonly grants: TopicGrants; ``` - *Type:* aws-cdk-lib.aws_sns.TopicGrants Collection of grant methods for a Topic. --- ##### `topicArn`^Required ```typescript public readonly topicArn: string; ``` - *Type:* string The ARN of the topic. --- ##### `topicName`^Required ```typescript public readonly topicName: string; ``` - *Type:* string The name of the topic. --- ##### `topicRef`^Required ```typescript public readonly topicRef: TopicReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_sns.TopicReference A reference to a Topic resource. --- ##### `masterKey`^Optional ```typescript public readonly masterKey: IKey; ``` - *Type:* aws-cdk-lib.aws_kms.IKey A KMS Key, either managed by this CDK app, or imported. This property applies only to server-side encryption. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### VpcEndpointService An extension for the VpcEndpointService construct that provides methods to create recommended alarms. #### Initializers ```typescript import { VpcEndpointService } from '@renovosolutions/cdk-library-cloudwatch-alarms' new VpcEndpointService(scope: Construct, id: string, props: VpcEndpointServiceProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_ec2.VpcEndpointServiceProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_ec2.VpcEndpointServiceProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | alarmRstPacketsSent | Creates an alarm that monitors the RstPacketsSent for the PrivateLink endpoint. | | applyRecommendedAlarms | Creates the recommended alarms for the PrivateLink VpcEndpointService. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `alarmRstPacketsSent` ```typescript public alarmRstPacketsSent(props: PrivateLinkServicesRstPacketsSentAlarmConfig): PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm[] ``` Creates an alarm that monitors the RstPacketsSent for the PrivateLink endpoint. ###### `props`^Required - *Type:* PrivateLinkServicesRstPacketsSentAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props: PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig): PrivateLinkServicesVpcEndpointServiceRecommendedAlarms ``` Creates the recommended alarms for the PrivateLink VpcEndpointService. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkServices](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#PrivateLinkServices) ###### `props`^Required - *Type:* PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig --- #### 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 { VpcEndpointService } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpcEndpointService.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 { VpcEndpointService } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpcEndpointService.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { VpcEndpointService } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpcEndpointService.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.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | acceptanceRequired | boolean | Whether to require manual acceptance of new connections to the service. | | allowedPrincipals | aws-cdk-lib.aws_iam.ArnPrincipal[] | One or more Principal ARNs to allow inbound connections to. | | vpcEndpointServiceId | string | The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx. | | vpcEndpointServiceLoadBalancers | aws-cdk-lib.aws_ec2.IVpcEndpointServiceLoadBalancer[] | One or more network load balancers to host the service. | | vpcEndpointServiceName | string | The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxx. | | vpcEndpointServiceRef | aws-cdk-lib.interfaces.aws_ec2.VPCEndpointServiceReference | A reference to a VPCEndpointService resource. | | contributorInsightsEnabled | boolean | Whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `acceptanceRequired`^Required ```typescript public readonly acceptanceRequired: boolean; ``` - *Type:* boolean Whether to require manual acceptance of new connections to the service. --- ##### `allowedPrincipals`^Required ```typescript public readonly allowedPrincipals: ArnPrincipal[]; ``` - *Type:* aws-cdk-lib.aws_iam.ArnPrincipal[] One or more Principal ARNs to allow inbound connections to. --- ##### `vpcEndpointServiceId`^Required ```typescript public readonly vpcEndpointServiceId: string; ``` - *Type:* string The id of the VPC Endpoint Service, like vpce-svc-xxxxxxxxxxxxxxxx. --- ##### `vpcEndpointServiceLoadBalancers`^Required ```typescript public readonly vpcEndpointServiceLoadBalancers: IVpcEndpointServiceLoadBalancer[]; ``` - *Type:* aws-cdk-lib.aws_ec2.IVpcEndpointServiceLoadBalancer[] One or more network load balancers to host the service. --- ##### `vpcEndpointServiceName`^Required ```typescript public readonly vpcEndpointServiceName: string; ``` - *Type:* string The service name of the VPC Endpoint Service that clients use to connect to, like com.amazonaws.vpce..vpce-svc-xxxxxxxxxxxxxxxx. --- ##### `vpcEndpointServiceRef`^Required ```typescript public readonly vpcEndpointServiceRef: VPCEndpointServiceReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_ec2.VPCEndpointServiceReference A reference to a VPCEndpointService resource. --- ##### `contributorInsightsEnabled`^Optional ```typescript public readonly contributorInsightsEnabled: boolean; ``` - *Type:* boolean Whether to enable the built-in Contributor Insights rules provided by AWS PrivateLink. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_PREFIX | string | The default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is `{ "Ref": "AWS::Region" }`). | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `DEFAULT_PREFIX`^Required ```typescript public readonly DEFAULT_PREFIX: string; ``` - *Type:* string The default value for a VPC Endpoint Service name prefix, useful if you do not have a synthesize-time region literal available (all you have is `{ "Ref": "AWS::Region" }`). --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ### VpnConnection An extension for the CfnVPNConnection construct that provides methods to create recommended alarms. #### Initializers ```typescript import { VpnConnection } from '@renovosolutions/cdk-library-cloudwatch-alarms' new VpnConnection(scope: Construct, id: string, props: CfnVPNConnectionProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | aws-cdk-lib.aws_ec2.CfnVPNConnectionProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* aws-cdk-lib.aws_ec2.CfnVPNConnectionProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. | | addDeletionOverride | Syntactic sugar for `addOverride(path, undefined)`. | | addDependency | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addDependsOn | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. | | addMetadata | Add a value to the CloudFormation Resource Metadata. | | addOverride | Adds an override to the synthesized CloudFormation resource. | | addPropertyDeletionOverride | Adds an override that deletes the value of a property from the resource definition. | | addPropertyOverride | Adds an override to a resource property. | | applyRemovalPolicy | Sets the deletion policy of the resource based on the removal policy specified. | | getAtt | Returns a token for an runtime attribute of this resource. | | getMetadata | Retrieve a value value from the CloudFormation Resource Metadata. | | obtainDependencies | Retrieves an array of resources this resource depends on. | | obtainResourceDependencies | Get a shallow copy of dependencies between this resource and other resources in the same stack. | | removeDependency | Indicates that this resource no longer depends on another resource. | | replaceDependency | Replaces one dependency with another. | | inspect | Examines the CloudFormation resource and discloses attributes. | | alarmTunnelState | Creates an alarm that monitors the TunnelState for the VPN vpnConnection. | | applyRecommendedAlarms | Creates the recommended alarms for the VpnConnection. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `overrideLogicalId` ```typescript public overrideLogicalId(newLogicalId: string): void ``` Overrides the auto-generated logical ID with a specific ID. ###### `newLogicalId`^Required - *Type:* string The new logical ID to use for this stack element. --- ##### `addDeletionOverride` ```typescript public addDeletionOverride(path: string): void ``` Syntactic sugar for `addOverride(path, undefined)`. ###### `path`^Required - *Type:* string The path of the value to delete. --- ##### `addDependency` ```typescript public addDependency(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### ~~`addDependsOn`~~ ```typescript public addDependsOn(target: CfnResource): void ``` Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `addMetadata` ```typescript public addMetadata(key: string, value: any): void ``` Add a value to the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ###### `value`^Required - *Type:* any --- ##### `addOverride` ```typescript public addOverride(path: string, value: any): void ``` Adds an override to the synthesized CloudFormation resource. To add a property override, either use `addPropertyOverride` or prefix `path` with "Properties." (i.e. `Properties.TopicName`). If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path. To include a literal `.` in the property name, prefix with a `\`. In most programming languages you will need to write this as `"\\."` because the `\` itself will need to be escaped. For example, ```typescript cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); ``` would add the overrides ```json "Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... } ``` The `value` argument to `addOverride` will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template. ###### `path`^Required - *Type:* string The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed. --- ###### `value`^Required - *Type:* any The value. Could be primitive or complex. --- ##### `addPropertyDeletionOverride` ```typescript public addPropertyDeletionOverride(propertyPath: string): void ``` Adds an override that deletes the value of a property from the resource definition. ###### `propertyPath`^Required - *Type:* string The path to the property. --- ##### `addPropertyOverride` ```typescript public addPropertyOverride(propertyPath: string, value: any): void ``` Adds an override to a resource property. Syntactic sugar for `addOverride("Properties.<...>", value)`. ###### `propertyPath`^Required - *Type:* string The path of the property. --- ###### `value`^Required - *Type:* any The value. --- ##### `applyRemovalPolicy` ```typescript public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void ``` Sets the deletion policy of the resource based on the removal policy specified. 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`). In some cases, a snapshot can be taken of the resource prior to deletion (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy can be found in the following link: > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options) ###### `policy`^Optional - *Type:* aws-cdk-lib.RemovalPolicy --- ###### `options`^Optional - *Type:* aws-cdk-lib.RemovalPolicyOptions --- ##### `getAtt` ```typescript public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference ``` Returns a token for an runtime attribute of this resource. Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility in case there is no generated attribute. ###### `attributeName`^Required - *Type:* string The name of the attribute. --- ###### `typeHint`^Optional - *Type:* aws-cdk-lib.ResolutionTypeHint --- ##### `getMetadata` ```typescript public getMetadata(key: string): any ``` Retrieve a value value from the CloudFormation Resource Metadata. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.) ###### `key`^Required - *Type:* string --- ##### `obtainDependencies` ```typescript public obtainDependencies(): (Stack | CfnResource)[] ``` Retrieves an array of resources this resource depends on. This assembles dependencies on resources across stacks (including nested stacks) automatically. ##### `obtainResourceDependencies` ```typescript public obtainResourceDependencies(): CfnResource[] ``` Get a shallow copy of dependencies between this resource and other resources in the same stack. ##### `removeDependency` ```typescript public removeDependency(target: CfnResource): void ``` Indicates that this resource no longer depends on another resource. This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource --- ##### `replaceDependency` ```typescript public replaceDependency(target: CfnResource, newTarget: CfnResource): void ``` Replaces one dependency with another. ###### `target`^Required - *Type:* aws-cdk-lib.CfnResource The dependency to replace. --- ###### `newTarget`^Required - *Type:* aws-cdk-lib.CfnResource The new dependency to add. --- ##### `inspect` ```typescript public inspect(inspector: TreeInspector): void ``` Examines the CloudFormation resource and discloses attributes. ###### `inspector`^Required - *Type:* aws-cdk-lib.TreeInspector tree inspector to collect and process attributes. --- ##### `alarmTunnelState` ```typescript public alarmTunnelState(props?: VpnTunnelStateAlarmConfig): VpnConnectionTunnelStateAlarm ``` Creates an alarm that monitors the TunnelState for the VPN vpnConnection. ###### `props`^Optional - *Type:* VpnTunnelStateAlarmConfig --- ##### `applyRecommendedAlarms` ```typescript public applyRecommendedAlarms(props?: VpnConnectionRecommendedAlarmsConfig): VpnConnectionRecommendedAlarms ``` Creates the recommended alarms for the VpnConnection. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#VPN](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#VPN) ###### `props`^Optional - *Type:* VpnConnectionRecommendedAlarmsConfig --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isCfnElement | Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). | | isCfnResource | Check whether the given object is a CfnResource. | | arnForVPNConnection | *No description.* | | fromVpnConnectionId | Creates a new IVPNConnectionRef from a vpnConnectionId. | | isCfnVPNConnection | Checks whether the given object is a CfnVPNConnection. | --- ##### `isConstruct` ```typescript import { VpnConnection } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnection.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. --- ##### `isCfnElement` ```typescript import { VpnConnection } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnection.isCfnElement(x: any) ``` Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template). Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack. ###### `x`^Required - *Type:* any --- ##### `isCfnResource` ```typescript import { VpnConnection } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnection.isCfnResource(x: any) ``` Check whether the given object is a CfnResource. ###### `x`^Required - *Type:* any --- ##### `arnForVPNConnection` ```typescript import { VpnConnection } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnection.arnForVPNConnection(resource: IVPNConnectionRef) ``` ###### `resource`^Required - *Type:* aws-cdk-lib.interfaces.aws_ec2.IVPNConnectionRef --- ##### `fromVpnConnectionId` ```typescript import { VpnConnection } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnection.fromVpnConnectionId(scope: Construct, id: string, vpnConnectionId: string) ``` Creates a new IVPNConnectionRef from a vpnConnectionId. ###### `scope`^Required - *Type:* constructs.Construct --- ###### `id`^Required - *Type:* string --- ###### `vpnConnectionId`^Required - *Type:* string --- ##### `isCfnVPNConnection` ```typescript import { VpnConnection } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnection.isCfnVPNConnection(x: any) ``` Checks whether the given object is a CfnVPNConnection. ###### `x`^Required - *Type:* any --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | creationStack | string[] | *No description.* | | logicalId | string | The logical ID for this CloudFormation stack element. | | stack | aws-cdk-lib.Stack | The stack in which this element is defined. | | ref | string | Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. | | cfnOptions | aws-cdk-lib.ICfnResourceOptions | Options for this resource, such as condition, update policy etc. | | cfnResourceType | string | AWS resource type. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | *No description.* | | attrVpnConnectionId | string | The ID of the VPN connection. | | tags | aws-cdk-lib.TagManager | Tag Manager which manages the tags for this resource. | | vpnConnectionRef | aws-cdk-lib.interfaces.aws_ec2.VPNConnectionReference | A reference to a VPNConnection resource. | | customerGatewayId | string | The ID of the customer gateway at your end of the VPN connection. | | type | string | The type of VPN connection. | | enableAcceleration | boolean \| aws-cdk-lib.IResolvable | Indicate whether to enable acceleration for the VPN connection. | | localIpv4NetworkCidr | string | The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. | | localIpv6NetworkCidr | string | The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. | | outsideIpAddressType | string | The type of IP address assigned to the outside interface of the customer gateway device. | | preSharedKeyStorage | string | Describes the storage location for an instance store-backed AMI. | | remoteIpv4NetworkCidr | string | The IPv4 CIDR on the AWS side of the VPN connection. | | remoteIpv6NetworkCidr | string | The IPv6 CIDR on the AWS side of the VPN connection. | | staticRoutesOnly | boolean \| aws-cdk-lib.IResolvable | Indicates whether the VPN connection uses static routes only. | | tagsRaw | aws-cdk-lib.CfnTag[] | Any tags assigned to the VPN connection. | | transitGatewayId | string | The ID of the transit gateway associated with the VPN connection. | | transportTransitGatewayAttachmentId | string | The transit gateway attachment ID to use for the VPN tunnel. | | tunnelBandwidth | string | The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. | | tunnelInsideIpVersion | string | Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. | | vpnConcentratorId | string | The ID of the VPN concentrator to associate with the VPN connection. | | vpnGatewayId | string | The ID of the virtual private gateway at the AWS side of the VPN connection. | | vpnTunnelOptionsSpecifications |

aws-cdk-lib.IResolvable \| aws-cdk-lib.IResolvable \| aws-cdk-lib.aws_ec2.CfnVPNConnection.VpnTunnelOptionsSpecificationProperty[]

| The tunnel options for the VPN connection. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `creationStack`^Required ```typescript public readonly creationStack: string[]; ``` - *Type:* string[] --- ##### `logicalId`^Required ```typescript public readonly logicalId: string; ``` - *Type:* string The logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree. To override this value, use `overrideLogicalId(newLogicalId)`. --- ##### `stack`^Required ```typescript public readonly stack: Stack; ``` - *Type:* aws-cdk-lib.Stack The stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly). --- ##### `ref`^Required ```typescript public readonly ref: string; ``` - *Type:* string Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. --- ##### `cfnOptions`^Required ```typescript public readonly cfnOptions: ICfnResourceOptions; ``` - *Type:* aws-cdk-lib.ICfnResourceOptions Options for this resource, such as condition, update policy etc. --- ##### `cfnResourceType`^Required ```typescript public readonly cfnResourceType: string; ``` - *Type:* string AWS resource type. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment --- ##### `attrVpnConnectionId`^Required ```typescript public readonly attrVpnConnectionId: string; ``` - *Type:* string The ID of the VPN connection. --- ##### `tags`^Required ```typescript public readonly tags: TagManager; ``` - *Type:* aws-cdk-lib.TagManager Tag Manager which manages the tags for this resource. --- ##### `vpnConnectionRef`^Required ```typescript public readonly vpnConnectionRef: VPNConnectionReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_ec2.VPNConnectionReference A reference to a VPNConnection resource. --- ##### `customerGatewayId`^Required ```typescript public readonly customerGatewayId: string; ``` - *Type:* string The ID of the customer gateway at your end of the VPN connection. --- ##### `type`^Required ```typescript public readonly type: string; ``` - *Type:* string The type of VPN connection. --- ##### `enableAcceleration`^Optional ```typescript public readonly enableAcceleration: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable Indicate whether to enable acceleration for the VPN connection. --- ##### `localIpv4NetworkCidr`^Optional ```typescript public readonly localIpv4NetworkCidr: string; ``` - *Type:* string The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. --- ##### `localIpv6NetworkCidr`^Optional ```typescript public readonly localIpv6NetworkCidr: string; ``` - *Type:* string The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. --- ##### `outsideIpAddressType`^Optional ```typescript public readonly outsideIpAddressType: string; ``` - *Type:* string The type of IP address assigned to the outside interface of the customer gateway device. --- ##### `preSharedKeyStorage`^Optional ```typescript public readonly preSharedKeyStorage: string; ``` - *Type:* string Describes the storage location for an instance store-backed AMI. --- ##### `remoteIpv4NetworkCidr`^Optional ```typescript public readonly remoteIpv4NetworkCidr: string; ``` - *Type:* string The IPv4 CIDR on the AWS side of the VPN connection. --- ##### `remoteIpv6NetworkCidr`^Optional ```typescript public readonly remoteIpv6NetworkCidr: string; ``` - *Type:* string The IPv6 CIDR on the AWS side of the VPN connection. --- ##### `staticRoutesOnly`^Optional ```typescript public readonly staticRoutesOnly: boolean | IResolvable; ``` - *Type:* boolean | aws-cdk-lib.IResolvable Indicates whether the VPN connection uses static routes only. --- ##### `tagsRaw`^Optional ```typescript public readonly tagsRaw: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] Any tags assigned to the VPN connection. --- ##### `transitGatewayId`^Optional ```typescript public readonly transitGatewayId: string; ``` - *Type:* string The ID of the transit gateway associated with the VPN connection. --- ##### `transportTransitGatewayAttachmentId`^Optional ```typescript public readonly transportTransitGatewayAttachmentId: string; ``` - *Type:* string The transit gateway attachment ID to use for the VPN tunnel. --- ##### `tunnelBandwidth`^Optional ```typescript public readonly tunnelBandwidth: string; ``` - *Type:* string The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. --- ##### `tunnelInsideIpVersion`^Optional ```typescript public readonly tunnelInsideIpVersion: string; ``` - *Type:* string Indicate whether the VPN tunnels process IPv4 or IPv6 traffic. --- ##### `vpnConcentratorId`^Optional ```typescript public readonly vpnConcentratorId: string; ``` - *Type:* string The ID of the VPN concentrator to associate with the VPN connection. --- ##### `vpnGatewayId`^Optional ```typescript public readonly vpnGatewayId: string; ``` - *Type:* string The ID of the virtual private gateway at the AWS side of the VPN connection. --- ##### `vpnTunnelOptionsSpecifications`^Optional ```typescript public readonly vpnTunnelOptionsSpecifications: IResolvable | (IResolvable | VpnTunnelOptionsSpecificationProperty)[]; ``` - *Type:* aws-cdk-lib.IResolvable | aws-cdk-lib.IResolvable | aws-cdk-lib.aws_ec2.CfnVPNConnection.VpnTunnelOptionsSpecificationProperty[] The tunnel options for the VPN connection. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. | --- ##### `CFN_RESOURCE_TYPE_NAME`^Required ```typescript public readonly CFN_RESOURCE_TYPE_NAME: string; ``` - *Type:* string The CloudFormation resource type name for this resource class. --- ### VpnConnectionRecommendedAlarms A construct that creates the recommended alarms for an VpnConnection. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#VPN](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#VPN) #### Initializers ```typescript import { VpnConnectionRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' new VpnConnectionRecommendedAlarms(scope: Construct, id: string, props: VpnConnectionRecommendedAlarmsProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | props | VpnConnectionRecommendedAlarmsProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.Construct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* VpnConnectionRecommendedAlarmsProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```typescript import { VpnConnectionRecommendedAlarms } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnectionRecommendedAlarms.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. | | alarmTunnelState | VpnConnectionTunnelStateAlarm | The TunnelState alarm. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `alarmTunnelState`^Optional ```typescript public readonly alarmTunnelState: VpnConnectionTunnelStateAlarm; ``` - *Type:* VpnConnectionTunnelStateAlarm The TunnelState alarm. --- ### VpnConnectionTunnelStateAlarm This alarm helps you understand if the state of one or more tunnels is DOWN. For troubleshooting, see VPN tunnel troubleshooting. The alarm is triggered when the monitored value is less than 1. #### Initializers ```typescript import { VpnConnectionTunnelStateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' new VpnConnectionTunnelStateAlarm(scope: IConstruct, id: string, props: VpnConnectionTunnelStateAlarmProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.IConstruct | *No description.* | | id | string | *No description.* | | props | VpnConnectionTunnelStateAlarmProps | *No description.* | --- ##### `scope`^Required - *Type:* constructs.IConstruct --- ##### `id`^Required - *Type:* string --- ##### `props`^Required - *Type:* VpnConnectionTunnelStateAlarmProps --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | applyRemovalPolicy | Apply the given removal policy to this resource. | | addAlarmAction | Trigger this action if the alarm fires. | | addInsufficientDataAction | Trigger this action if there is insufficient data to evaluate the alarm. | | addOkAction | Trigger this action if the alarm returns from breaching state into ok state. | | renderAlarmRule | AlarmRule indicating ALARM state for Alarm. | | toAnnotation | Turn this alarm into a horizontal annotation. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] --- ##### `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 --- ##### `addAlarmAction` ```typescript public addAlarmAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm fires. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addInsufficientDataAction` ```typescript public addInsufficientDataAction(actions: ...IAlarmAction[]): void ``` Trigger this action if there is insufficient data to evaluate the alarm. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `addOkAction` ```typescript public addOkAction(actions: ...IAlarmAction[]): void ``` Trigger this action if the alarm returns from breaching state into ok state. Typically SnsAction or AutoScalingAction. ###### `actions`^Required - *Type:* ...aws-cdk-lib.aws_cloudwatch.IAlarmAction[] --- ##### `renderAlarmRule` ```typescript public renderAlarmRule(): string ``` AlarmRule indicating ALARM state for Alarm. ##### `toAnnotation` ```typescript public toAnnotation(): HorizontalAnnotation ``` Turn this alarm into a horizontal annotation. This is useful if you want to represent an Alarm in a non-AlarmWidget. An `AlarmWidget` can directly show an alarm, but it can only show a single alarm and no other metrics. Instead, you can convert the alarm to a HorizontalAnnotation and add it as an annotation to another graph. This might be useful if: - You want to show multiple alarms inside a single graph, for example if you have both a "small margin/long period" alarm as well as a "large margin/short period" alarm. - You want to show an Alarm line in a graph with multiple metrics in it. #### 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. | | fromAlarmArn | Import an existing CloudWatch alarm provided an ARN. | | fromAlarmName | Import an existing CloudWatch alarm provided an Name. | --- ##### `isConstruct` ```typescript import { VpnConnectionTunnelStateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnectionTunnelStateAlarm.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 { VpnConnectionTunnelStateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnectionTunnelStateAlarm.isOwnedResource(construct: IConstruct) ``` Returns true if the construct was created by CDK, and false otherwise. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `isResource` ```typescript import { VpnConnectionTunnelStateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnectionTunnelStateAlarm.isResource(construct: IConstruct) ``` Check whether the given construct is a Resource. ###### `construct`^Required - *Type:* constructs.IConstruct --- ##### `fromAlarmArn` ```typescript import { VpnConnectionTunnelStateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnectionTunnelStateAlarm.fromAlarmArn(scope: Construct, id: string, alarmArn: string) ``` Import an existing CloudWatch alarm provided an ARN. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmArn`^Required - *Type:* string Alarm ARN (i.e. arn:aws:cloudwatch:::alarm:Foo). --- ##### `fromAlarmName` ```typescript import { VpnConnectionTunnelStateAlarm } from '@renovosolutions/cdk-library-cloudwatch-alarms' VpnConnectionTunnelStateAlarm.fromAlarmName(scope: Construct, id: string, alarmName: string) ``` Import an existing CloudWatch alarm provided an Name. ###### `scope`^Required - *Type:* constructs.Construct The parent creating construct (usually `this`). --- ###### `id`^Required - *Type:* string The construct's name. --- ###### `alarmName`^Required - *Type:* string Alarm Name. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | env | aws-cdk-lib.interfaces.ResourceEnvironment | The environment this resource belongs to. | | stack | aws-cdk-lib.Stack | The stack in which this resource is defined. | | alarmArn | string | ARN of this alarm. | | alarmName | string | Name of this alarm. | | alarmRef | aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference | A reference to a Alarm resource. | | metric | aws-cdk-lib.aws_cloudwatch.IMetric | The metric object this alarm was based on. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `env`^Required ```typescript public readonly env: ResourceEnvironment; ``` - *Type:* aws-cdk-lib.interfaces.ResourceEnvironment The environment this resource belongs to. For resources that are created and managed in a Stack (those created by creating new class instances like `new Role()`, `new Bucket()`, etc.), this is always the same as the environment of the stack they belong to. For referenced resources (those obtained from referencing methods like `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they 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. --- ##### `alarmArn`^Required ```typescript public readonly alarmArn: string; ``` - *Type:* string ARN of this alarm. --- ##### `alarmName`^Required ```typescript public readonly alarmName: string; ``` - *Type:* string Name of this alarm. --- ##### `alarmRef`^Required ```typescript public readonly alarmRef: AlarmReference; ``` - *Type:* aws-cdk-lib.interfaces.aws_cloudwatch.AlarmReference A reference to a Alarm resource. --- ##### `metric`^Required ```typescript public readonly metric: IMetric; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IMetric The metric object this alarm was based on. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | ANOMALY_DETECTION_NO_THRESHOLD | number | Conventional value for the threshold property when creating anomaly detection alarms. | | PROPERTY_INJECTION_ID | string | Uniquely identifies this class. | --- ##### `ANOMALY_DETECTION_NO_THRESHOLD`^Required ```typescript public readonly ANOMALY_DETECTION_NO_THRESHOLD: number; ``` - *Type:* number Conventional value for the threshold property when creating anomaly detection alarms. Anomaly detection alarms don't have numbered threshold. Instead, they have a dynamically calculated threshold based on the metric math expression that contains a metric expression. The `threshold` property is required, but the value is ignored. This constant has the value 0, and has a symbolic name to indicate why the threshold is 0. You can use `new AnomalyDetectionAlarm()` to avoid having to pass the `threshold` property at all. --- ##### `PROPERTY_INJECTION_ID`^Required ```typescript public readonly PROPERTY_INJECTION_ID: string; ``` - *Type:* string Uniquely identifies this class. --- ## Structs ### AlarmBaseProps The base properties for an alarm where default values are consistent across all alarms. #### Initializer ```typescript import { AlarmBaseProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const alarmBaseProps: AlarmBaseProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### ApiGateway4XXErrorAlarmConfig Configuration for the 4XXError alarm. #### Initializer ```typescript import { ApiGateway4XXErrorAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGateway4XXErrorAlarmConfig: ApiGateway4XXErrorAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The threshold value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The threshold value against which the specified statistic is compared. The unit is an absolute count of errors, not a percentage. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect high rates of client-side errors for the API Gateway requests. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - 4XXError' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### ApiGateway5XXErrorAlarmConfig Configuration for the 5XXError alarm. #### Initializer ```typescript import { ApiGateway5XXErrorAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGateway5XXErrorAlarmConfig: ApiGateway5XXErrorAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The threshold value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The threshold value against which the specified statistic is compared. The unit is an absolute count of errors, not a percentage. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect high rates of server-side errors for the API Gateway requests. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - 5XXError' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ### ApiGatewayAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { ApiGatewayAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayAlarmBaseConfig: ApiGatewayAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### ApiGatewayAnomalyAlarmBaseConfig The common optional configuration for anomaly detection alarms. These alarms use a fixed 5-minute metric period and do not expose a configurable `period`, because finer periods produce noisier, less reliable anomaly detection bands. #### Initializer ```typescript import { ApiGatewayAnomalyAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayAnomalyAlarmBaseConfig: ApiGatewayAnomalyAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ### ApiGatewayCountAnomalyAlarmConfig Configuration for the Count anomaly detection alarm. #### Initializer ```typescript import { ApiGatewayCountAnomalyAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayCountAnomalyAlarmConfig: ApiGatewayCountAnomalyAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator used to compare the metric against the anomaly detection band. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the anomaly detection band. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This anomaly detection alarm detects unexpected drops in request volume for the API Gateway stage, which can indicate clients calling the wrong endpoints or an outage upstream. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - CountAnomaly' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* cloudwatch.ComparisonOperator.LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD The comparison operator used to compare the metric against the anomaly detection band. Defaults to `LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD` to catch both unexpected traffic drops (the main case AWS's recommended static `Count` alarm targets but cannot express with a fixed value) and unusual spikes (e.g. abuse or retry storms). --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 4 The number of periods over which data is compared to the anomaly detection band. --- ### ApiGatewayDetailedAlarmConfig The common properties for the ApiGateway alarms when monitoring resource and method dimensions. #### Initializer ```typescript import { ApiGatewayDetailedAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayDetailedAlarmConfig: ApiGatewayDetailedAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alias | string | The alias of the resource to monitor, used as a discriminator in the alarm name. | | method | string | The method to monitor. | | resource | string | The resource to monitor. | --- ##### `alias`^Required ```typescript public readonly alias: string; ``` - *Type:* string The alias of the resource to monitor, used as a discriminator in the alarm name. --- ##### `method`^Required ```typescript public readonly method: string; ``` - *Type:* string The method to monitor. --- ##### `resource`^Required ```typescript public readonly resource: string; ``` - *Type:* string The resource to monitor. --- ### ApiGatewayIntegrationLatencyAnomalyAlarmConfig Configuration for the IntegrationLatency anomaly detection alarm. #### Initializer ```typescript import { ApiGatewayIntegrationLatencyAnomalyAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayIntegrationLatencyAnomalyAlarmConfig: ApiGatewayIntegrationLatencyAnomalyAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator used to compare the metric against the anomaly detection band. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the anomaly detection band. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This anomaly detection alarm detects unusual drift in the API Gateway backend integration latency, which can indicate backend performance issues independent of API Gateway overhead. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - IntegrationLatencyAnomaly' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* cloudwatch.ComparisonOperator.GREATER_THAN_UPPER_THRESHOLD The comparison operator used to compare the metric against the anomaly detection band. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the anomaly detection band. --- ### ApiGatewayLatencyAlarmConfig Configuration for the Latency alarm. #### Initializer ```typescript import { ApiGatewayLatencyAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayLatencyAlarmConfig: ApiGatewayLatencyAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value in milliseconds against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the API Gateway requests in a stage have high latency. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - Latency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 2500 The value in milliseconds against which the specified statistic is compared. The suggested threshold value does not work for all API workloads. However, you can use it as a starting point for the threshold. You can then choose different threshold values based on the workload and acceptable latency, performance, and SLA requirements for the API. If it is acceptable for the API to have a higher latency in general, you can set a higher threshold value to make the alarm less sensitive. However, if the API is expected to provide near real-time responses, set a lower threshold value. You can also analyze historical data to determine what the expected baseline latency is for the application workload and then tune the threshold value accordingly. --- ### ApiGatewayLatencyAnomalyAlarmConfig Configuration for the Latency anomaly detection alarm. #### Initializer ```typescript import { ApiGatewayLatencyAnomalyAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayLatencyAnomalyAlarmConfig: ApiGatewayLatencyAnomalyAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator used to compare the metric against the anomaly detection band. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the anomaly detection band. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This anomaly detection alarm detects unusual drift in the API Gateway request latency compared to the expected baseline. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - LatencyAnomaly' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* cloudwatch.ComparisonOperator.GREATER_THAN_UPPER_THRESHOLD The comparison operator used to compare the metric against the anomaly detection band. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the anomaly detection band. --- ### ApiGatewayRestApi4XXErrorAlarmProps The properties for the ApiGatewayRestApi4XXErrorAlarm construct. #### Initializer ```typescript import { ApiGatewayRestApi4XXErrorAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApi4XXErrorAlarmProps: ApiGatewayRestApi4XXErrorAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | api | aws-cdk-lib.aws_apigateway.RestApi | The ApiGateway api to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The threshold value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The ApiGateway api to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The threshold value against which the specified statistic is compared. The unit is an absolute count of errors, not a percentage. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect high rates of client-side errors for the API Gateway requests. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - 4XXError' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### ApiGatewayRestApi5XXErrorAlarmProps The properties for the ApiGatewayRestApi5XXErrorAlarm construct. #### Initializer ```typescript import { ApiGatewayRestApi5XXErrorAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApi5XXErrorAlarmProps: ApiGatewayRestApi5XXErrorAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | api | aws-cdk-lib.aws_apigateway.RestApi | The ApiGateway api to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The threshold value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The ApiGateway api to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The threshold value against which the specified statistic is compared. The unit is an absolute count of errors, not a percentage. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect high rates of server-side errors for the API Gateway requests. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - 5XXError' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ### ApiGatewayRestApiAlarmProps The common properties for the ApiGateway RestApi alarms. #### Initializer ```typescript import { ApiGatewayRestApiAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApiAlarmProps: ApiGatewayRestApiAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | api | aws-cdk-lib.aws_apigateway.RestApi | The ApiGateway api to monitor. | --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The ApiGateway api to monitor. --- ### ApiGatewayRestApiCountAnomalyAlarmProps The properties for the ApiGatewayRestApiCountAnomalyAlarm construct. #### Initializer ```typescript import { ApiGatewayRestApiCountAnomalyAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApiCountAnomalyAlarmProps: ApiGatewayRestApiCountAnomalyAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | api | aws-cdk-lib.aws_apigateway.RestApi | The ApiGateway api to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator used to compare the metric against the anomaly detection band. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the anomaly detection band. | --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The ApiGateway api to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This anomaly detection alarm detects unexpected drops in request volume for the API Gateway stage, which can indicate clients calling the wrong endpoints or an outage upstream. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - CountAnomaly' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* cloudwatch.ComparisonOperator.LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD The comparison operator used to compare the metric against the anomaly detection band. Defaults to `LESS_THAN_LOWER_OR_GREATER_THAN_UPPER_THRESHOLD` to catch both unexpected traffic drops (the main case AWS's recommended static `Count` alarm targets but cannot express with a fixed value) and unusual spikes (e.g. abuse or retry storms). --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 4 The number of periods over which data is compared to the anomaly detection band. --- ### ApiGatewayRestApiDetailedLatencyAlarmConfig Configuration for the Latency alarm when monitoring resource and method dimensions. #### Initializer ```typescript import { ApiGatewayRestApiDetailedLatencyAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApiDetailedLatencyAlarmConfig: ApiGatewayRestApiDetailedLatencyAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value in milliseconds against which the specified statistic is compared. | | alias | string | The alias of the resource to monitor, used as a discriminator in the alarm name. | | method | string | The method to monitor. | | resource | string | The resource to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the API Gateway requests in a stage have high latency. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - Latency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 2500 The value in milliseconds against which the specified statistic is compared. The suggested threshold value does not work for all API workloads. However, you can use it as a starting point for the threshold. You can then choose different threshold values based on the workload and acceptable latency, performance, and SLA requirements for the API. If it is acceptable for the API to have a higher latency in general, you can set a higher threshold value to make the alarm less sensitive. However, if the API is expected to provide near real-time responses, set a lower threshold value. You can also analyze historical data to determine what the expected baseline latency is for the application workload and then tune the threshold value accordingly. --- ##### `alias`^Required ```typescript public readonly alias: string; ``` - *Type:* string The alias of the resource to monitor, used as a discriminator in the alarm name. --- ##### `method`^Required ```typescript public readonly method: string; ``` - *Type:* string The method to monitor. --- ##### `resource`^Required ```typescript public readonly resource: string; ``` - *Type:* string The resource to monitor. --- ### ApiGatewayRestApiDetailedLatencyAlarmProps The properties for the ApiGatewayRestApiDetailedLatencyAlarm construct. #### Initializer ```typescript import { ApiGatewayRestApiDetailedLatencyAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApiDetailedLatencyAlarmProps: ApiGatewayRestApiDetailedLatencyAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | api | aws-cdk-lib.aws_apigateway.RestApi | The ApiGateway api to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value in milliseconds against which the specified statistic is compared. | | alias | string | The alias of the resource to monitor, used as a discriminator in the alarm name. | | method | string | The method to monitor. | | resource | string | The resource to monitor. | --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The ApiGateway api to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the API Gateway requests in a stage have high latency. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - Latency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 2500 The value in milliseconds against which the specified statistic is compared. The suggested threshold value does not work for all API workloads. However, you can use it as a starting point for the threshold. You can then choose different threshold values based on the workload and acceptable latency, performance, and SLA requirements for the API. If it is acceptable for the API to have a higher latency in general, you can set a higher threshold value to make the alarm less sensitive. However, if the API is expected to provide near real-time responses, set a lower threshold value. You can also analyze historical data to determine what the expected baseline latency is for the application workload and then tune the threshold value accordingly. --- ##### `alias`^Required ```typescript public readonly alias: string; ``` - *Type:* string The alias of the resource to monitor, used as a discriminator in the alarm name. --- ##### `method`^Required ```typescript public readonly method: string; ``` - *Type:* string The method to monitor. --- ##### `resource`^Required ```typescript public readonly resource: string; ``` - *Type:* string The resource to monitor. --- ### ApiGatewayRestApiIntegrationLatencyAnomalyAlarmProps The properties for the ApiGatewayRestApiIntegrationLatencyAnomalyAlarm construct. #### Initializer ```typescript import { ApiGatewayRestApiIntegrationLatencyAnomalyAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApiIntegrationLatencyAnomalyAlarmProps: ApiGatewayRestApiIntegrationLatencyAnomalyAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | api | aws-cdk-lib.aws_apigateway.RestApi | The ApiGateway api to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator used to compare the metric against the anomaly detection band. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the anomaly detection band. | --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The ApiGateway api to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This anomaly detection alarm detects unusual drift in the API Gateway backend integration latency, which can indicate backend performance issues independent of API Gateway overhead. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - IntegrationLatencyAnomaly' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* cloudwatch.ComparisonOperator.GREATER_THAN_UPPER_THRESHOLD The comparison operator used to compare the metric against the anomaly detection band. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the anomaly detection band. --- ### ApiGatewayRestApiLatencyAlarmProps The properties for the ApiGatewayRestApiLatencyAlarm construct. #### Initializer ```typescript import { ApiGatewayRestApiLatencyAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApiLatencyAlarmProps: ApiGatewayRestApiLatencyAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | api | aws-cdk-lib.aws_apigateway.RestApi | The ApiGateway api to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value in milliseconds against which the specified statistic is compared. | --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The ApiGateway api to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the API Gateway requests in a stage have high latency. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - Latency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 2500 The value in milliseconds against which the specified statistic is compared. The suggested threshold value does not work for all API workloads. However, you can use it as a starting point for the threshold. You can then choose different threshold values based on the workload and acceptable latency, performance, and SLA requirements for the API. If it is acceptable for the API to have a higher latency in general, you can set a higher threshold value to make the alarm less sensitive. However, if the API is expected to provide near real-time responses, set a lower threshold value. You can also analyze historical data to determine what the expected baseline latency is for the application workload and then tune the threshold value accordingly. --- ### ApiGatewayRestApiLatencyAnomalyAlarmProps The properties for the ApiGatewayRestApiLatencyAnomalyAlarm construct. #### Initializer ```typescript import { ApiGatewayRestApiLatencyAnomalyAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApiLatencyAnomalyAlarmProps: ApiGatewayRestApiLatencyAnomalyAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | api | aws-cdk-lib.aws_apigateway.RestApi | The ApiGateway api to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator used to compare the metric against the anomaly detection band. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the anomaly detection band. | --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The ApiGateway api to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This anomaly detection alarm detects unusual drift in the API Gateway request latency compared to the expected baseline. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* apiName + ' - LatencyAnomaly' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* cloudwatch.ComparisonOperator.GREATER_THAN_UPPER_THRESHOLD The comparison operator used to compare the metric against the anomaly detection band. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the anomaly detection band. --- ### ApiGatewayRestApiRecommendedAlarmsConfig Configurations for the recommended alarms for an ApiGateway RestApi. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { ApiGatewayRestApiRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApiRecommendedAlarmsConfig: ApiGatewayRestApiRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config4XXErrorAlarm | ApiGateway4XXErrorAlarmConfig | The configuration for the 4XXError alarm. | | config5XXErrorAlarm | ApiGateway5XXErrorAlarmConfig | The configuration for the 5XXError alarm. | | configCountAnomalyAlarm | ApiGatewayCountAnomalyAlarmConfig | The configuration for the Count anomaly detection alarm. | | configDetailedLatencyAlarmList | ApiGatewayRestApiDetailedLatencyAlarmConfig[] | The configuration list for the detailed Latency alarm. | | configIntegrationLatencyAnomalyAlarm | ApiGatewayIntegrationLatencyAnomalyAlarmConfig | The configuration for the IntegrationLatency anomaly detection alarm. | | configLatencyAlarm | ApiGatewayLatencyAlarmConfig | The configuration for the Latency alarm. | | configLatencyAnomalyAlarm | ApiGatewayLatencyAnomalyAlarmConfig | The configuration for the Latency anomaly detection alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ApiGatewayRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `config4XXErrorAlarm`^Required ```typescript public readonly config4XXErrorAlarm: ApiGateway4XXErrorAlarmConfig; ``` - *Type:* ApiGateway4XXErrorAlarmConfig The configuration for the 4XXError alarm. --- ##### `config5XXErrorAlarm`^Required ```typescript public readonly config5XXErrorAlarm: ApiGateway5XXErrorAlarmConfig; ``` - *Type:* ApiGateway5XXErrorAlarmConfig The configuration for the 5XXError alarm. --- ##### `configCountAnomalyAlarm`^Optional ```typescript public readonly configCountAnomalyAlarm: ApiGatewayCountAnomalyAlarmConfig; ``` - *Type:* ApiGatewayCountAnomalyAlarmConfig The configuration for the Count anomaly detection alarm. --- ##### `configDetailedLatencyAlarmList`^Optional ```typescript public readonly configDetailedLatencyAlarmList: ApiGatewayRestApiDetailedLatencyAlarmConfig[]; ``` - *Type:* ApiGatewayRestApiDetailedLatencyAlarmConfig[] The configuration list for the detailed Latency alarm. --- ##### `configIntegrationLatencyAnomalyAlarm`^Optional ```typescript public readonly configIntegrationLatencyAnomalyAlarm: ApiGatewayIntegrationLatencyAnomalyAlarmConfig; ``` - *Type:* ApiGatewayIntegrationLatencyAnomalyAlarmConfig The configuration for the IntegrationLatency anomaly detection alarm. --- ##### `configLatencyAlarm`^Optional ```typescript public readonly configLatencyAlarm: ApiGatewayLatencyAlarmConfig; ``` - *Type:* ApiGatewayLatencyAlarmConfig The configuration for the Latency alarm. --- ##### `configLatencyAnomalyAlarm`^Optional ```typescript public readonly configLatencyAnomalyAlarm: ApiGatewayLatencyAnomalyAlarmConfig; ``` - *Type:* ApiGatewayLatencyAnomalyAlarmConfig The configuration for the Latency anomaly detection alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ApiGatewayRecommendedAlarmsMetrics[]; ``` - *Type:* ApiGatewayRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### ApiGatewayRestApiRecommendedAlarmsProps Properties for the ApiGatewayRestApiRecommendedAlarms construct. #### Initializer ```typescript import { ApiGatewayRestApiRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const apiGatewayRestApiRecommendedAlarmsProps: ApiGatewayRestApiRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config4XXErrorAlarm | ApiGateway4XXErrorAlarmConfig | The configuration for the 4XXError alarm. | | config5XXErrorAlarm | ApiGateway5XXErrorAlarmConfig | The configuration for the 5XXError alarm. | | configCountAnomalyAlarm | ApiGatewayCountAnomalyAlarmConfig | The configuration for the Count anomaly detection alarm. | | configDetailedLatencyAlarmList | ApiGatewayRestApiDetailedLatencyAlarmConfig[] | The configuration list for the detailed Latency alarm. | | configIntegrationLatencyAnomalyAlarm | ApiGatewayIntegrationLatencyAnomalyAlarmConfig | The configuration for the IntegrationLatency anomaly detection alarm. | | configLatencyAlarm | ApiGatewayLatencyAlarmConfig | The configuration for the Latency alarm. | | configLatencyAnomalyAlarm | ApiGatewayLatencyAnomalyAlarmConfig | The configuration for the Latency anomaly detection alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ApiGatewayRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | api | aws-cdk-lib.aws_apigateway.RestApi | The ApiGateway api to monitor. | --- ##### `config4XXErrorAlarm`^Required ```typescript public readonly config4XXErrorAlarm: ApiGateway4XXErrorAlarmConfig; ``` - *Type:* ApiGateway4XXErrorAlarmConfig The configuration for the 4XXError alarm. --- ##### `config5XXErrorAlarm`^Required ```typescript public readonly config5XXErrorAlarm: ApiGateway5XXErrorAlarmConfig; ``` - *Type:* ApiGateway5XXErrorAlarmConfig The configuration for the 5XXError alarm. --- ##### `configCountAnomalyAlarm`^Optional ```typescript public readonly configCountAnomalyAlarm: ApiGatewayCountAnomalyAlarmConfig; ``` - *Type:* ApiGatewayCountAnomalyAlarmConfig The configuration for the Count anomaly detection alarm. --- ##### `configDetailedLatencyAlarmList`^Optional ```typescript public readonly configDetailedLatencyAlarmList: ApiGatewayRestApiDetailedLatencyAlarmConfig[]; ``` - *Type:* ApiGatewayRestApiDetailedLatencyAlarmConfig[] The configuration list for the detailed Latency alarm. --- ##### `configIntegrationLatencyAnomalyAlarm`^Optional ```typescript public readonly configIntegrationLatencyAnomalyAlarm: ApiGatewayIntegrationLatencyAnomalyAlarmConfig; ``` - *Type:* ApiGatewayIntegrationLatencyAnomalyAlarmConfig The configuration for the IntegrationLatency anomaly detection alarm. --- ##### `configLatencyAlarm`^Optional ```typescript public readonly configLatencyAlarm: ApiGatewayLatencyAlarmConfig; ``` - *Type:* ApiGatewayLatencyAlarmConfig The configuration for the Latency alarm. --- ##### `configLatencyAnomalyAlarm`^Optional ```typescript public readonly configLatencyAnomalyAlarm: ApiGatewayLatencyAnomalyAlarmConfig; ``` - *Type:* ApiGatewayLatencyAnomalyAlarmConfig The configuration for the Latency anomaly detection alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ApiGatewayRecommendedAlarmsMetrics[]; ``` - *Type:* ApiGatewayRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `api`^Required ```typescript public readonly api: RestApi; ``` - *Type:* aws-cdk-lib.aws_apigateway.RestApi The ApiGateway api to monitor. --- ### ApplicationLoadBalancerAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { ApplicationLoadBalancerAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerAlarmBaseConfig: ApplicationLoadBalancerAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### ApplicationLoadBalancerAlarmProps The common properties for the ApplicationLoadBalancer alarms. #### Initializer ```typescript import { ApplicationLoadBalancerAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerAlarmProps: ApplicationLoadBalancerAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer | The ApplicationLoadBalancer to monitor. | --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: ApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer The ApplicationLoadBalancer to monitor. --- ### ApplicationLoadBalancerHttpCode4xxCountAlarmConfig Configuration for the HTTPCode_ELB_4XX_Count alarm. #### Initializer ```typescript import { ApplicationLoadBalancerHttpCode4xxCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerHttpCode4xxCountAlarmConfig: ApplicationLoadBalancerHttpCode4xxCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the load balancer is generating 4XX errors. A high number of 4XX errors can indicate client-side issues or misconfigured requests. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - HTTPCode_ELB_4XX_Count' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ### ApplicationLoadBalancerHttpCode4xxCountAlarmProps The properties for the ApplicationLoadBalancerHttpCode4xxCountAlarm construct. #### Initializer ```typescript import { ApplicationLoadBalancerHttpCode4xxCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerHttpCode4xxCountAlarmProps: ApplicationLoadBalancerHttpCode4xxCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer | The ApplicationLoadBalancer to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: ApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer The ApplicationLoadBalancer to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the load balancer is generating 4XX errors. A high number of 4XX errors can indicate client-side issues or misconfigured requests. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - HTTPCode_ELB_4XX_Count' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ### ApplicationLoadBalancerHttpCode5xxCountAlarmConfig Configuration for the HTTPCode_ELB_5XX_Count alarm. #### Initializer ```typescript import { ApplicationLoadBalancerHttpCode5xxCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerHttpCode5xxCountAlarmConfig: ApplicationLoadBalancerHttpCode5xxCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the load balancer is generating 5XX errors. A high number of 5XX errors can indicate issues with the load balancer itself. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - HTTPCode_ELB_5XX_Count' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ### ApplicationLoadBalancerHttpCode5xxCountAlarmProps The properties for the ApplicationLoadBalancerHttpCode5xxCountAlarm construct. #### Initializer ```typescript import { ApplicationLoadBalancerHttpCode5xxCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerHttpCode5xxCountAlarmProps: ApplicationLoadBalancerHttpCode5xxCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer | The ApplicationLoadBalancer to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: ApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer The ApplicationLoadBalancer to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the load balancer is generating 5XX errors. A high number of 5XX errors can indicate issues with the load balancer itself. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - HTTPCode_ELB_5XX_Count' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ### ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig Configuration for the HTTPCode_Target_5XX_Count alarm. #### Initializer ```typescript import { ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig: ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the targets are generating 5XX errors. A high number of 5XX errors can indicate issues with the application or backend services. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - HTTPCode_Target_5XX_Count' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the acceptable number of 5XX errors from targets. --- ### ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps The properties for the ApplicationLoadBalancerHttpCodeTarget5xxCountAlarm construct. #### Initializer ```typescript import { ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerHttpCodeTarget5xxCountAlarmProps: ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer | The ApplicationLoadBalancer to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: ApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer The ApplicationLoadBalancer to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the targets are generating 5XX errors. A high number of 5XX errors can indicate issues with the application or backend services. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - HTTPCode_Target_5XX_Count' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the acceptable number of 5XX errors from targets. --- ### ApplicationLoadBalancerRecommendedAlarmsConfig Configurations for the recommended alarms for an ApplicationLoadBalancer. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { ApplicationLoadBalancerRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerRecommendedAlarmsConfig: ApplicationLoadBalancerRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configHttpCode4xxCountAlarm | ApplicationLoadBalancerHttpCode4xxCountAlarmConfig | The configuration for the HTTPCode_ELB_4XX_Count alarm. | | configHttpCode5xxCountAlarm | ApplicationLoadBalancerHttpCode5xxCountAlarmConfig | The configuration for the HTTPCode_ELB_5XX_Count alarm. | | configHttpCodeTarget5xxCountAlarm | ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig | The configuration for the HTTPCode_Target_5XX_Count alarm. | | configRejectedConnectionCountAlarm | ApplicationLoadBalancerRejectedConnectionCountAlarmConfig | The configuration for the RejectedConnectionCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ApplicationLoadBalancerRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configHttpCode4xxCountAlarm`^Optional ```typescript public readonly configHttpCode4xxCountAlarm: ApplicationLoadBalancerHttpCode4xxCountAlarmConfig; ``` - *Type:* ApplicationLoadBalancerHttpCode4xxCountAlarmConfig The configuration for the HTTPCode_ELB_4XX_Count alarm. --- ##### `configHttpCode5xxCountAlarm`^Optional ```typescript public readonly configHttpCode5xxCountAlarm: ApplicationLoadBalancerHttpCode5xxCountAlarmConfig; ``` - *Type:* ApplicationLoadBalancerHttpCode5xxCountAlarmConfig The configuration for the HTTPCode_ELB_5XX_Count alarm. --- ##### `configHttpCodeTarget5xxCountAlarm`^Optional ```typescript public readonly configHttpCodeTarget5xxCountAlarm: ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig; ``` - *Type:* ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig The configuration for the HTTPCode_Target_5XX_Count alarm. --- ##### `configRejectedConnectionCountAlarm`^Optional ```typescript public readonly configRejectedConnectionCountAlarm: ApplicationLoadBalancerRejectedConnectionCountAlarmConfig; ``` - *Type:* ApplicationLoadBalancerRejectedConnectionCountAlarmConfig The configuration for the RejectedConnectionCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ApplicationLoadBalancerRecommendedAlarmsMetrics[]; ``` - *Type:* ApplicationLoadBalancerRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### ApplicationLoadBalancerRecommendedAlarmsProps Properties for the ApplicationLoadBalancerRecommendedAlarms construct. #### Initializer ```typescript import { ApplicationLoadBalancerRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerRecommendedAlarmsProps: ApplicationLoadBalancerRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configHttpCode4xxCountAlarm | ApplicationLoadBalancerHttpCode4xxCountAlarmConfig | The configuration for the HTTPCode_ELB_4XX_Count alarm. | | configHttpCode5xxCountAlarm | ApplicationLoadBalancerHttpCode5xxCountAlarmConfig | The configuration for the HTTPCode_ELB_5XX_Count alarm. | | configHttpCodeTarget5xxCountAlarm | ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig | The configuration for the HTTPCode_Target_5XX_Count alarm. | | configRejectedConnectionCountAlarm | ApplicationLoadBalancerRejectedConnectionCountAlarmConfig | The configuration for the RejectedConnectionCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ApplicationLoadBalancerRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer | The ApplicationLoadBalancer to monitor. | --- ##### `configHttpCode4xxCountAlarm`^Optional ```typescript public readonly configHttpCode4xxCountAlarm: ApplicationLoadBalancerHttpCode4xxCountAlarmConfig; ``` - *Type:* ApplicationLoadBalancerHttpCode4xxCountAlarmConfig The configuration for the HTTPCode_ELB_4XX_Count alarm. --- ##### `configHttpCode5xxCountAlarm`^Optional ```typescript public readonly configHttpCode5xxCountAlarm: ApplicationLoadBalancerHttpCode5xxCountAlarmConfig; ``` - *Type:* ApplicationLoadBalancerHttpCode5xxCountAlarmConfig The configuration for the HTTPCode_ELB_5XX_Count alarm. --- ##### `configHttpCodeTarget5xxCountAlarm`^Optional ```typescript public readonly configHttpCodeTarget5xxCountAlarm: ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig; ``` - *Type:* ApplicationLoadBalancerHttpCodeTarget5xxCountAlarmConfig The configuration for the HTTPCode_Target_5XX_Count alarm. --- ##### `configRejectedConnectionCountAlarm`^Optional ```typescript public readonly configRejectedConnectionCountAlarm: ApplicationLoadBalancerRejectedConnectionCountAlarmConfig; ``` - *Type:* ApplicationLoadBalancerRejectedConnectionCountAlarmConfig The configuration for the RejectedConnectionCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ApplicationLoadBalancerRecommendedAlarmsMetrics[]; ``` - *Type:* ApplicationLoadBalancerRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: ApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer The ApplicationLoadBalancer to monitor. --- ### ApplicationLoadBalancerRejectedConnectionCountAlarmConfig Configuration for the RejectedConnectionCount alarm. #### Initializer ```typescript import { ApplicationLoadBalancerRejectedConnectionCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerRejectedConnectionCountAlarmConfig: ApplicationLoadBalancerRejectedConnectionCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the load balancer is rejecting connections. Rejected connections can indicate that the load balancer has reached its maximum connection limit. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - RejectedConnectionCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the acceptable number of rejected connections. --- ### ApplicationLoadBalancerRejectedConnectionCountAlarmProps The properties for the ApplicationLoadBalancerRejectedConnectionCountAlarm construct. #### Initializer ```typescript import { ApplicationLoadBalancerRejectedConnectionCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationLoadBalancerRejectedConnectionCountAlarmProps: ApplicationLoadBalancerRejectedConnectionCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer | The ApplicationLoadBalancer to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: ApplicationLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer The ApplicationLoadBalancer to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the load balancer is rejecting connections. Rejected connections can indicate that the load balancer has reached its maximum connection limit. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - RejectedConnectionCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the acceptable number of rejected connections. --- ### ApplicationTargetGroupAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { ApplicationTargetGroupAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationTargetGroupAlarmBaseConfig: ApplicationTargetGroupAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### ApplicationTargetGroupAlarmProps The common properties for the ApplicationTargetGroup alarms. #### Initializer ```typescript import { ApplicationTargetGroupAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationTargetGroupAlarmProps: ApplicationTargetGroupAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | targetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup | The ApplicationTargetGroup to monitor. | --- ##### `targetGroup`^Required ```typescript public readonly targetGroup: ApplicationTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup The ApplicationTargetGroup to monitor. --- ### ApplicationTargetGroupHealthyHostCountAlarmConfig Configuration for the HealthyHostCount alarm. #### Initializer ```typescript import { ApplicationTargetGroupHealthyHostCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationTargetGroupHealthyHostCountAlarmConfig: ApplicationTargetGroupHealthyHostCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the number of healthy hosts in the target group falls below the threshold. A low number of healthy hosts can indicate service availability issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* targetGroupName + ' - HealthyHostCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 The value against which the specified statistic is compared. You should set this threshold based on the minimum number of healthy hosts required for your application to function properly. --- ### ApplicationTargetGroupHealthyHostCountAlarmProps The properties for the ApplicationTargetGroupHealthyHostCountAlarm construct. #### Initializer ```typescript import { ApplicationTargetGroupHealthyHostCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationTargetGroupHealthyHostCountAlarmProps: ApplicationTargetGroupHealthyHostCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | targetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup | The ApplicationTargetGroup to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `targetGroup`^Required ```typescript public readonly targetGroup: ApplicationTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup The ApplicationTargetGroup to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the number of healthy hosts in the target group falls below the threshold. A low number of healthy hosts can indicate service availability issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* targetGroupName + ' - HealthyHostCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 The value against which the specified statistic is compared. You should set this threshold based on the minimum number of healthy hosts required for your application to function properly. --- ### ApplicationTargetGroupRecommendedAlarmsConfig Configurations for the recommended alarms for an ApplicationTargetGroup. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { ApplicationTargetGroupRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationTargetGroupRecommendedAlarmsConfig: ApplicationTargetGroupRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configHealthyHostCountAlarm | ApplicationTargetGroupHealthyHostCountAlarmConfig | The configuration for the HealthyHostCount alarm. | | configUnHealthyHostCountAlarm | ApplicationTargetGroupUnHealthyHostCountAlarmConfig | The configuration for the UnHealthyHostCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ApplicationTargetGroupRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configHealthyHostCountAlarm`^Optional ```typescript public readonly configHealthyHostCountAlarm: ApplicationTargetGroupHealthyHostCountAlarmConfig; ``` - *Type:* ApplicationTargetGroupHealthyHostCountAlarmConfig The configuration for the HealthyHostCount alarm. --- ##### `configUnHealthyHostCountAlarm`^Optional ```typescript public readonly configUnHealthyHostCountAlarm: ApplicationTargetGroupUnHealthyHostCountAlarmConfig; ``` - *Type:* ApplicationTargetGroupUnHealthyHostCountAlarmConfig The configuration for the UnHealthyHostCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ApplicationTargetGroupRecommendedAlarmsMetrics[]; ``` - *Type:* ApplicationTargetGroupRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### ApplicationTargetGroupRecommendedAlarmsProps Properties for the ApplicationTargetGroupRecommendedAlarms construct. #### Initializer ```typescript import { ApplicationTargetGroupRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationTargetGroupRecommendedAlarmsProps: ApplicationTargetGroupRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configHealthyHostCountAlarm | ApplicationTargetGroupHealthyHostCountAlarmConfig | The configuration for the HealthyHostCount alarm. | | configUnHealthyHostCountAlarm | ApplicationTargetGroupUnHealthyHostCountAlarmConfig | The configuration for the UnHealthyHostCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ApplicationTargetGroupRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | targetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup | The ApplicationTargetGroup to monitor. | --- ##### `configHealthyHostCountAlarm`^Optional ```typescript public readonly configHealthyHostCountAlarm: ApplicationTargetGroupHealthyHostCountAlarmConfig; ``` - *Type:* ApplicationTargetGroupHealthyHostCountAlarmConfig The configuration for the HealthyHostCount alarm. --- ##### `configUnHealthyHostCountAlarm`^Optional ```typescript public readonly configUnHealthyHostCountAlarm: ApplicationTargetGroupUnHealthyHostCountAlarmConfig; ``` - *Type:* ApplicationTargetGroupUnHealthyHostCountAlarmConfig The configuration for the UnHealthyHostCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ApplicationTargetGroupRecommendedAlarmsMetrics[]; ``` - *Type:* ApplicationTargetGroupRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `targetGroup`^Required ```typescript public readonly targetGroup: ApplicationTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup The ApplicationTargetGroup to monitor. --- ### ApplicationTargetGroupUnHealthyHostCountAlarmConfig Configuration for the UnHealthyHostCount alarm. #### Initializer ```typescript import { ApplicationTargetGroupUnHealthyHostCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationTargetGroupUnHealthyHostCountAlarmConfig: ApplicationTargetGroupUnHealthyHostCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the number of unhealthy hosts in the target group exceeds the threshold. A high number of unhealthy hosts can indicate service health issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* targetGroupName + ' - UnHealthyHostCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the maximum number of unhealthy hosts that your application can tolerate before service is impacted. --- ### ApplicationTargetGroupUnHealthyHostCountAlarmProps The properties for the ApplicationTargetGroupUnHealthyHostCountAlarm construct. #### Initializer ```typescript import { ApplicationTargetGroupUnHealthyHostCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const applicationTargetGroupUnHealthyHostCountAlarmProps: ApplicationTargetGroupUnHealthyHostCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | targetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup | The ApplicationTargetGroup to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `targetGroup`^Required ```typescript public readonly targetGroup: ApplicationTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationTargetGroup The ApplicationTargetGroup to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the number of unhealthy hosts in the target group exceeds the threshold. A high number of unhealthy hosts can indicate service health issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* targetGroupName + ' - UnHealthyHostCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the maximum number of unhealthy hosts that your application can tolerate before service is impacted. --- ### AutoScalingAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { AutoScalingAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const autoScalingAlarmBaseConfig: AutoScalingAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### AutoScalingGroupAlarmProps The common properties for the EC2 AutoScalingGroup alarms. #### Initializer ```typescript import { AutoScalingGroupAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const autoScalingGroupAlarmProps: AutoScalingGroupAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | autoScalingGroup | aws-cdk-lib.aws_autoscaling.AutoScalingGroup | The EC2 AutoScalingGroup to monitor. | --- ##### `autoScalingGroup`^Required ```typescript public readonly autoScalingGroup: AutoScalingGroup; ``` - *Type:* aws-cdk-lib.aws_autoscaling.AutoScalingGroup The EC2 AutoScalingGroup to monitor. --- ### AutoScalingGroupGroupInServiceCapacityAlarmProps The properties for the AutoScalingGroupGroupInServiceCapacityAlarm construct. #### Initializer ```typescript import { AutoScalingGroupGroupInServiceCapacityAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const autoScalingGroupGroupInServiceCapacityAlarmProps: AutoScalingGroupGroupInServiceCapacityAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | autoScalingGroup | aws-cdk-lib.aws_autoscaling.AutoScalingGroup | The EC2 AutoScalingGroup to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The threshold value should be the minimum capacity required to run your workload. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `autoScalingGroup`^Required ```typescript public readonly autoScalingGroup: AutoScalingGroup; ``` - *Type:* aws-cdk-lib.aws_autoscaling.AutoScalingGroup The EC2 AutoScalingGroup to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The threshold value should be the minimum capacity required to run your workload. In most cases, you can set this to match the GroupDesiredCapacity metric. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect a low availability in your auto scaling group because of launch failures or suspended launches. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* autoScalingGroupName + ' - GroupInServiceCapacity' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 10 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 10 The number of periods over which data is compared to the specified threshold. --- ### AutoScalingGroupInServiceCapacityAlarmConfig Configuration for the GroupInServiceCapacity alarm. #### Initializer ```typescript import { AutoScalingGroupInServiceCapacityAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const autoScalingGroupInServiceCapacityAlarmConfig: AutoScalingGroupInServiceCapacityAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The threshold value should be the minimum capacity required to run your workload. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The threshold value should be the minimum capacity required to run your workload. In most cases, you can set this to match the GroupDesiredCapacity metric. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect a low availability in your auto scaling group because of launch failures or suspended launches. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* autoScalingGroupName + ' - GroupInServiceCapacity' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 10 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 10 The number of periods over which data is compared to the specified threshold. --- ### AutoScalingGroupRecommendedAlarmsConfig Configurations for the recommended alarms for an EC2 AutoScalingGroup. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { AutoScalingGroupRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const autoScalingGroupRecommendedAlarmsConfig: AutoScalingGroupRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configGroupInServiceCapacityAlarm | AutoScalingGroupInServiceCapacityAlarmConfig | The configuration for the GroupInServiceCapacity alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | AutoScalingRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configGroupInServiceCapacityAlarm`^Required ```typescript public readonly configGroupInServiceCapacityAlarm: AutoScalingGroupInServiceCapacityAlarmConfig; ``` - *Type:* AutoScalingGroupInServiceCapacityAlarmConfig The configuration for the GroupInServiceCapacity alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: AutoScalingRecommendedAlarmsMetrics[]; ``` - *Type:* AutoScalingRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### AutoScalingGroupRecommendedAlarmsProps Properties for the AutoScalingGroupRecommendedAlarms construct. #### Initializer ```typescript import { AutoScalingGroupRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const autoScalingGroupRecommendedAlarmsProps: AutoScalingGroupRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configGroupInServiceCapacityAlarm | AutoScalingGroupInServiceCapacityAlarmConfig | The configuration for the GroupInServiceCapacity alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | AutoScalingRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | autoScalingGroup | aws-cdk-lib.aws_autoscaling.AutoScalingGroup | The EC2 AutoScalingGroup to monitor. | --- ##### `configGroupInServiceCapacityAlarm`^Required ```typescript public readonly configGroupInServiceCapacityAlarm: AutoScalingGroupInServiceCapacityAlarmConfig; ``` - *Type:* AutoScalingGroupInServiceCapacityAlarmConfig The configuration for the GroupInServiceCapacity alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: AutoScalingRecommendedAlarmsMetrics[]; ``` - *Type:* AutoScalingRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `autoScalingGroup`^Required ```typescript public readonly autoScalingGroup: AutoScalingGroup; ``` - *Type:* aws-cdk-lib.aws_autoscaling.AutoScalingGroup The EC2 AutoScalingGroup to monitor. --- ### CloudFront5xxErrorRateAlarmConfig Configuration for the 5xxErrorRate alarm. #### Initializer ```typescript import { CloudFront5xxErrorRateAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFront5xxErrorRateAlarmConfig: CloudFront5xxErrorRateAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The recommended threshold value for this alarm is highly dependent on the tolerance for 5xx responses. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The recommended threshold value for this alarm is highly dependent on the tolerance for 5xx responses. You can analyze historical data and trends, and then set the threshold accordingly. Because 5xx errors can be caused by transient issues, we recommend that you set the threshold to a value greater than 0 so that the alarm is not too sensitive. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect problems with serving requests from the origin server, or problems with communication between CloudFront and your origin server. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - 5xxErrorRate' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### CloudFrontAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { CloudFrontAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontAlarmBaseConfig: CloudFrontAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### CloudFrontDetailedAlarmConfig The common properties for the CloudFront alarms when monitoring resource and method dimensions. #### Initializer ```typescript import { CloudFrontDetailedAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDetailedAlarmConfig: CloudFrontDetailedAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | functionName | string | The name of the function to monitor, used as a discriminator in the alarm name. | --- ##### `functionName`^Required ```typescript public readonly functionName: string; ``` - *Type:* string The name of the function to monitor, used as a discriminator in the alarm name. --- ### CloudFrontDistribution5xxErrorRateAlarmProps The properties for the CloudFrontDistribution5xxErrorRateAlarm construct. #### Initializer ```typescript import { CloudFrontDistribution5xxErrorRateAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistribution5xxErrorRateAlarmProps: CloudFrontDistribution5xxErrorRateAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | The CloudFront Distribution to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The recommended threshold value for this alarm is highly dependent on the tolerance for 5xx responses. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The CloudFront Distribution to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The recommended threshold value for this alarm is highly dependent on the tolerance for 5xx responses. You can analyze historical data and trends, and then set the threshold accordingly. Because 5xx errors can be caused by transient issues, we recommend that you set the threshold to a value greater than 0 so that the alarm is not too sensitive. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect problems with serving requests from the origin server, or problems with communication between CloudFront and your origin server. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - 5xxErrorRate' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### CloudFrontDistributionAlarmProps The common properties for the CloudFront Distribution alarms. #### Initializer ```typescript import { CloudFrontDistributionAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionAlarmProps: CloudFrontDistributionAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | The CloudFront Distribution to monitor. | --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The CloudFront Distribution to monitor. --- ### CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig Configuration for the FunctionExecutionErrors alarm when monitoring resource and method dimensions. #### Initializer ```typescript import { CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig: CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | We recommend to set the threshold to 0 because an execution error indicates a problem with the code that occurs at runtime. | | functionName | string | The name of the function to monitor, used as a discriminator in the alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect execution errors from CloudFront functions. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - ' + functionName + ' - FunctionExecutionErrors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 We recommend to set the threshold to 0 because an execution error indicates a problem with the code that occurs at runtime. --- ##### `functionName`^Required ```typescript public readonly functionName: string; ``` - *Type:* string The name of the function to monitor, used as a discriminator in the alarm name. --- ### CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps The properties for the CloudFrontDistributionDetailedFunctionExecutionErrorsAlarm construct. #### Initializer ```typescript import { CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps: CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | The CloudFront Distribution to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | We recommend to set the threshold to 0 because an execution error indicates a problem with the code that occurs at runtime. | | functionName | string | The name of the function to monitor, used as a discriminator in the alarm name. | --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The CloudFront Distribution to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect execution errors from CloudFront functions. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - ' + functionName + ' - FunctionExecutionErrors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 We recommend to set the threshold to 0 because an execution error indicates a problem with the code that occurs at runtime. --- ##### `functionName`^Required ```typescript public readonly functionName: string; ``` - *Type:* string The name of the function to monitor, used as a discriminator in the alarm name. --- ### CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig Configuration for the FunctionThrottles alarm when monitoring resource and method dimensions. #### Initializer ```typescript import { CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionDetailedFunctionThrottlesAlarmConfig: CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | We recommend setting the threshold to 0, to allow quicker resolution of the function throttles. | | functionName | string | The name of the function to monitor, used as a discriminator in the alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when your CloudFront function is throttled so that you can react and resolve the issue for a smooth customer experience. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - ' + functionName + ' - FunctionThrottles' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 We recommend setting the threshold to 0, to allow quicker resolution of the function throttles. --- ##### `functionName`^Required ```typescript public readonly functionName: string; ``` - *Type:* string The name of the function to monitor, used as a discriminator in the alarm name. --- ### CloudFrontDistributionDetailedFunctionThrottlesAlarmProps The properties for the CloudFrontDistributionDetailedFunctionThrottlesAlarm construct. #### Initializer ```typescript import { CloudFrontDistributionDetailedFunctionThrottlesAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionDetailedFunctionThrottlesAlarmProps: CloudFrontDistributionDetailedFunctionThrottlesAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | The CloudFront Distribution to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | We recommend setting the threshold to 0, to allow quicker resolution of the function throttles. | | functionName | string | The name of the function to monitor, used as a discriminator in the alarm name. | --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The CloudFront Distribution to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when your CloudFront function is throttled so that you can react and resolve the issue for a smooth customer experience. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - ' + functionName + ' - FunctionThrottles' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 We recommend setting the threshold to 0, to allow quicker resolution of the function throttles. --- ##### `functionName`^Required ```typescript public readonly functionName: string; ``` - *Type:* string The name of the function to monitor, used as a discriminator in the alarm name. --- ### CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig Configuration for the FunctionValidationErrors alarm when monitoring resource and method dimensions. #### Initializer ```typescript import { CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig: CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | A value greater than 0 indicates a validation error. | | functionName | string | The name of the function to monitor, used as a discriminator in the alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect validation errors from CloudFront functions. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - ' + functionName + ' - FunctionValidationErrors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 2 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 A value greater than 0 indicates a validation error. We recommend setting the threshold to 0 because validation errors imply a problem when CloudFront functions hand off back to CloudFront. For example, CloudFront needs the HTTP Host header in order to process a request. There is nothing stopping a user from deleting the Host header in their CloudFront functions code. But when CloudFront gets the response back and the Host header is missing, CloudFront throws a validation error. --- ##### `functionName`^Required ```typescript public readonly functionName: string; ``` - *Type:* string The name of the function to monitor, used as a discriminator in the alarm name. --- ### CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps The properties for the CloudFrontDistributionDetailedFunctionValidationErrorsAlarm construct. #### Initializer ```typescript import { CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps: CloudFrontDistributionDetailedFunctionValidationErrorsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | The CloudFront Distribution to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | A value greater than 0 indicates a validation error. | | functionName | string | The name of the function to monitor, used as a discriminator in the alarm name. | --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The CloudFront Distribution to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect validation errors from CloudFront functions. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - ' + functionName + ' - FunctionValidationErrors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 2 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 A value greater than 0 indicates a validation error. We recommend setting the threshold to 0 because validation errors imply a problem when CloudFront functions hand off back to CloudFront. For example, CloudFront needs the HTTP Host header in order to process a request. There is nothing stopping a user from deleting the Host header in their CloudFront functions code. But when CloudFront gets the response back and the Host header is missing, CloudFront throws a validation error. --- ##### `functionName`^Required ```typescript public readonly functionName: string; ``` - *Type:* string The name of the function to monitor, used as a discriminator in the alarm name. --- ### CloudFrontDistributionOriginLatencyAlarmProps The properties for the CloudFrontDistributionOriginLatencyAlarm construct. #### Initializer ```typescript import { CloudFrontDistributionOriginLatencyAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionOriginLatencyAlarmProps: CloudFrontDistributionOriginLatencyAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | The CloudFront Distribution to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | You should calculate the value of about 80% of the origin response timeout, and use the result as the threshold value. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The CloudFront Distribution to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number You should calculate the value of about 80% of the origin response timeout, and use the result as the threshold value. If this metric is consistently close to the origin response timeout value, you might start experiencing 504 errors. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect problems with the origin server taking too long to respond. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - OriginLatency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### CloudFrontDistributionRecommendedAlarmsConfig Configurations for the recommended alarms for an CloudFront Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { CloudFrontDistributionRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionRecommendedAlarmsConfig: CloudFrontDistributionRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config5xxErrorRateAlarm | CloudFront5xxErrorRateAlarmConfig | The configuration for the 5xxErrorRate alarm. | | configOriginLatencyAlarm | CloudFrontOriginLatencyAlarmConfig | The configuration for the OriginLatency alarm. | | configDetailedFunctionExecutionErrorsAlarmList | CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig[] | The configuration list for the detailed FunctionExecutionErrors alarm. | | configDetailedFunctionThrottlesAlarmList | CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig[] | The configuration list for the detailed FunctionThrottles alarm. | | configDetailedFunctionValidationErrorsAlarmList | CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig[] | The configuration list for the detailed FunctionValidationErrors alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | CloudFrontRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `config5xxErrorRateAlarm`^Required ```typescript public readonly config5xxErrorRateAlarm: CloudFront5xxErrorRateAlarmConfig; ``` - *Type:* CloudFront5xxErrorRateAlarmConfig The configuration for the 5xxErrorRate alarm. --- ##### `configOriginLatencyAlarm`^Required ```typescript public readonly configOriginLatencyAlarm: CloudFrontOriginLatencyAlarmConfig; ``` - *Type:* CloudFrontOriginLatencyAlarmConfig The configuration for the OriginLatency alarm. --- ##### `configDetailedFunctionExecutionErrorsAlarmList`^Optional ```typescript public readonly configDetailedFunctionExecutionErrorsAlarmList: CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig[]; ``` - *Type:* CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig[] The configuration list for the detailed FunctionExecutionErrors alarm. --- ##### `configDetailedFunctionThrottlesAlarmList`^Optional ```typescript public readonly configDetailedFunctionThrottlesAlarmList: CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig[]; ``` - *Type:* CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig[] The configuration list for the detailed FunctionThrottles alarm. --- ##### `configDetailedFunctionValidationErrorsAlarmList`^Optional ```typescript public readonly configDetailedFunctionValidationErrorsAlarmList: CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig[]; ``` - *Type:* CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig[] The configuration list for the detailed FunctionValidationErrors alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: CloudFrontRecommendedAlarmsMetrics[]; ``` - *Type:* CloudFrontRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### CloudFrontDistributionRecommendedAlarmsProps Properties for the CloudFrontDistributionRecommendedAlarms construct. #### Initializer ```typescript import { CloudFrontDistributionRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontDistributionRecommendedAlarmsProps: CloudFrontDistributionRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config5xxErrorRateAlarm | CloudFront5xxErrorRateAlarmConfig | The configuration for the 5xxErrorRate alarm. | | configOriginLatencyAlarm | CloudFrontOriginLatencyAlarmConfig | The configuration for the OriginLatency alarm. | | configDetailedFunctionExecutionErrorsAlarmList | CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig[] | The configuration list for the detailed FunctionExecutionErrors alarm. | | configDetailedFunctionThrottlesAlarmList | CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig[] | The configuration list for the detailed FunctionThrottles alarm. | | configDetailedFunctionValidationErrorsAlarmList | CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig[] | The configuration list for the detailed FunctionValidationErrors alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | CloudFrontRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | distribution | aws-cdk-lib.aws_cloudfront.Distribution | The CloudFront Distribution to monitor. | --- ##### `config5xxErrorRateAlarm`^Required ```typescript public readonly config5xxErrorRateAlarm: CloudFront5xxErrorRateAlarmConfig; ``` - *Type:* CloudFront5xxErrorRateAlarmConfig The configuration for the 5xxErrorRate alarm. --- ##### `configOriginLatencyAlarm`^Required ```typescript public readonly configOriginLatencyAlarm: CloudFrontOriginLatencyAlarmConfig; ``` - *Type:* CloudFrontOriginLatencyAlarmConfig The configuration for the OriginLatency alarm. --- ##### `configDetailedFunctionExecutionErrorsAlarmList`^Optional ```typescript public readonly configDetailedFunctionExecutionErrorsAlarmList: CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig[]; ``` - *Type:* CloudFrontDistributionDetailedFunctionExecutionErrorsAlarmConfig[] The configuration list for the detailed FunctionExecutionErrors alarm. --- ##### `configDetailedFunctionThrottlesAlarmList`^Optional ```typescript public readonly configDetailedFunctionThrottlesAlarmList: CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig[]; ``` - *Type:* CloudFrontDistributionDetailedFunctionThrottlesAlarmConfig[] The configuration list for the detailed FunctionThrottles alarm. --- ##### `configDetailedFunctionValidationErrorsAlarmList`^Optional ```typescript public readonly configDetailedFunctionValidationErrorsAlarmList: CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig[]; ``` - *Type:* CloudFrontDistributionDetailedFunctionValidationErrorsAlarmConfig[] The configuration list for the detailed FunctionValidationErrors alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: CloudFrontRecommendedAlarmsMetrics[]; ``` - *Type:* CloudFrontRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `distribution`^Required ```typescript public readonly distribution: Distribution; ``` - *Type:* aws-cdk-lib.aws_cloudfront.Distribution The CloudFront Distribution to monitor. --- ### CloudFrontFunctionExecutionErrorsAlarmConfig Configuration for the FunctionExecutionErrors alarm. #### Initializer ```typescript import { CloudFrontFunctionExecutionErrorsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontFunctionExecutionErrorsAlarmConfig: CloudFrontFunctionExecutionErrorsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | We recommend to set the threshold to 0 because an execution error indicates a problem with the code that occurs at runtime. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect execution errors from CloudFront functions. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - ' + functionName + ' - FunctionExecutionErrors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 We recommend to set the threshold to 0 because an execution error indicates a problem with the code that occurs at runtime. --- ### CloudFrontFunctionThrottlesAlarmConfig Configuration for the FunctionThrottles alarm. #### Initializer ```typescript import { CloudFrontFunctionThrottlesAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontFunctionThrottlesAlarmConfig: CloudFrontFunctionThrottlesAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | We recommend setting the threshold to 0, to allow quicker resolution of the function throttles. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when your CloudFront function is throttled so that you can react and resolve the issue for a smooth customer experience. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - ' + functionName + ' - FunctionThrottles' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 We recommend setting the threshold to 0, to allow quicker resolution of the function throttles. --- ### CloudFrontFunctionValidationErrorsAlarmConfig Configuration for the FunctionValidationErrors alarm. #### Initializer ```typescript import { CloudFrontFunctionValidationErrorsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontFunctionValidationErrorsAlarmConfig: CloudFrontFunctionValidationErrorsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | A value greater than 0 indicates a validation error. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect validation errors from CloudFront functions. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - ' + functionName + ' - FunctionValidationErrors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 2 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 A value greater than 0 indicates a validation error. We recommend setting the threshold to 0 because validation errors imply a problem when CloudFront functions hand off back to CloudFront. For example, CloudFront needs the HTTP Host header in order to process a request. There is nothing stopping a user from deleting the Host header in their CloudFront functions code. But when CloudFront gets the response back and the Host header is missing, CloudFront throws a validation error. --- ### CloudFrontOriginLatencyAlarmConfig Configuration for the OriginLatency alarm. #### Initializer ```typescript import { CloudFrontOriginLatencyAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const cloudFrontOriginLatencyAlarmConfig: CloudFrontOriginLatencyAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | You should calculate the value of about 80% of the origin response timeout, and use the result as the threshold value. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number You should calculate the value of about 80% of the origin response timeout, and use the result as the threshold value. If this metric is consistently close to the origin response timeout value, you might start experiencing 504 errors. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect problems with the origin server taking too long to respond. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* distributionId + ' - OriginLatency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### DmsAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { DmsAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsAlarmBaseConfig: DmsAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ### DmsAnomalyDetectionAlarmBaseConfig The common optional configuration for anomaly detection alarms. Anomaly detection alarms have a fixed period of 5 minutes as required by AWS CloudWatch, so the period property is not configurable. #### Initializer ```typescript import { DmsAnomalyDetectionAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsAnomalyDetectionAlarmBaseConfig: DmsAnomalyDetectionAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 (standard deviation for anomaly detection) The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ### DmsCdcLatencySourceAlarmConfig Configuration for the CdcLatencySource alarm. #### Initializer ```typescript import { DmsCdcLatencySourceAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsCdcLatencySourceAlarmConfig: DmsCdcLatencySourceAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator to use for the alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The latency threshold in seconds. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm monitors CDC latency from the source database. High values may indicate replication lag or source database performance issues. This can affect data freshness in real-time applications. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationTaskIdentifier + ' - CDCLatencySource' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* GREATER_THAN_THRESHOLD (for detecting high latency issues) The comparison operator to use for the alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 (allow for some variance while still detecting issues) The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 (to avoid false alarms from temporary fluctuations) The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 300 (5 minutes - for detecting high latency issues) The latency threshold in seconds. This alarm can be used to detect: - High latency indicating replication lag or source database performance issues - Potential data freshness problems affecting real-time applications Consider your application's tolerance for data lag when setting this threshold. --- ### DmsCdcLatencyTargetAlarmConfig Configuration for the CdcLatencyTarget alarm. #### Initializer ```typescript import { DmsCdcLatencyTargetAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsCdcLatencyTargetAlarmConfig: DmsCdcLatencyTargetAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator to use for the alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The latency threshold in seconds. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm monitors CDC latency to the target database. High values may indicate replication lag or target database performance issues. This can affect data consistency in downstream applications. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationTaskIdentifier + ' - CDCLatencyTarget' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* GREATER_THAN_THRESHOLD (for detecting high latency issues) The comparison operator to use for the alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 (allow for some variance while still detecting issues) The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 (to avoid false alarms from temporary fluctuations) The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 300 (5 minutes - for detecting high latency issues) The latency threshold in seconds. This alarm can be used to detect: - High latency indicating target database performance issues or replication lag - Potential data consistency problems affecting downstream applications Consider your application's tolerance for data lag when setting this threshold. --- ### DmsCpuUtilizationAlarmConfig Configuration for the CpuUtilization alarm. #### Initializer ```typescript import { DmsCpuUtilizationAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsCpuUtilizationAlarmConfig: DmsCpuUtilizationAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The percentage (0-100) value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high CPU utilization for the DMS Replication Instance. Consistent high CPU utilization can indicate a resource bottleneck or application performance problems. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - CPUUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 The percentage (0-100) value against which the specified statistic is compared. The service metrics for CPU utilization might exceed 100% utilization. However, we recommend that you monitor the metric for high CPU utilization to avoid impacting other services. --- ### DmsFreeableMemoryAlarmConfig Configuration for the FreeableMemory alarm. #### Initializer ```typescript import { DmsFreeableMemoryAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsFreeableMemoryAlarmConfig: DmsFreeableMemoryAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The amount in bytes against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The amount in bytes against which the specified statistic is compared. Depending on the workload and instance class, different values for the threshold can be appropriate. Ideally, available memory should not go below 25% of total memory for prolonged periods. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to help prevent running out of memory. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - FreeableMemory' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### DmsFreeStorageSpaceAlarmConfig Configuration for the FreeStorageSpace alarm. #### Initializer ```typescript import { DmsFreeStorageSpaceAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsFreeStorageSpaceAlarmConfig: DmsFreeStorageSpaceAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The amount in bytes value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The amount in bytes value against which the specified statistic is compared. The threshold value will depend on the currently allocated storage space. Typically, you should calculate the value of 10 percent of the allocated storage space and use that result as the threshold value. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps prevent storage full issues. This can prevent downtime that occurs when your replication instance runs out of storage. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - FreeStorageSpace' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### DmsReplicationInstanceAlarmProps The common properties for the DMS Replication Instance alarms. #### Initializer ```typescript import { DmsReplicationInstanceAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationInstanceAlarmProps: DmsReplicationInstanceAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicationInstance | aws-cdk-lib.aws_dms.CfnReplicationInstance | The DMS Replication Instance to monitor. | --- ##### `replicationInstance`^Required ```typescript public readonly replicationInstance: CfnReplicationInstance; ``` - *Type:* aws-cdk-lib.aws_dms.CfnReplicationInstance The DMS Replication Instance to monitor. --- ### DmsReplicationInstanceCpuUtilizationAlarmProps The properties for the DmsReplicationInstanceCpuUtilizationAlarm construct. #### Initializer ```typescript import { DmsReplicationInstanceCpuUtilizationAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationInstanceCpuUtilizationAlarmProps: DmsReplicationInstanceCpuUtilizationAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicationInstance | aws-cdk-lib.aws_dms.CfnReplicationInstance | The DMS Replication Instance to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The percentage (0-100) value against which the specified statistic is compared. | --- ##### `replicationInstance`^Required ```typescript public readonly replicationInstance: CfnReplicationInstance; ``` - *Type:* aws-cdk-lib.aws_dms.CfnReplicationInstance The DMS Replication Instance to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high CPU utilization for the DMS Replication Instance. Consistent high CPU utilization can indicate a resource bottleneck or application performance problems. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - CPUUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 The percentage (0-100) value against which the specified statistic is compared. The service metrics for CPU utilization might exceed 100% utilization. However, we recommend that you monitor the metric for high CPU utilization to avoid impacting other services. --- ### DmsReplicationInstanceFreeableMemoryAlarmProps The properties for the DmsReplicationInstanceFreeableMemoryAlarm construct. #### Initializer ```typescript import { DmsReplicationInstanceFreeableMemoryAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationInstanceFreeableMemoryAlarmProps: DmsReplicationInstanceFreeableMemoryAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicationInstance | aws-cdk-lib.aws_dms.CfnReplicationInstance | The DMS Replication Instance to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The amount in bytes against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `replicationInstance`^Required ```typescript public readonly replicationInstance: CfnReplicationInstance; ``` - *Type:* aws-cdk-lib.aws_dms.CfnReplicationInstance The DMS Replication Instance to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The amount in bytes against which the specified statistic is compared. Depending on the workload and instance class, different values for the threshold can be appropriate. Ideally, available memory should not go below 25% of total memory for prolonged periods. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to help prevent running out of memory. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - FreeableMemory' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### DmsReplicationInstanceFreeStorageSpaceAlarmProps The properties for the DmsReplicationInstanceFreeStorageSpaceAlarm construct. #### Initializer ```typescript import { DmsReplicationInstanceFreeStorageSpaceAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationInstanceFreeStorageSpaceAlarmProps: DmsReplicationInstanceFreeStorageSpaceAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicationInstance | aws-cdk-lib.aws_dms.CfnReplicationInstance | The DMS Replication Instance to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The amount in bytes value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `replicationInstance`^Required ```typescript public readonly replicationInstance: CfnReplicationInstance; ``` - *Type:* aws-cdk-lib.aws_dms.CfnReplicationInstance The DMS Replication Instance to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The amount in bytes value against which the specified statistic is compared. The threshold value will depend on the currently allocated storage space. Typically, you should calculate the value of 10 percent of the allocated storage space and use that result as the threshold value. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps prevent storage full issues. This can prevent downtime that occurs when your replication instance runs out of storage. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - FreeStorageSpace' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### DmsReplicationInstanceRecommendedAlarmsConfig Configurations for the recommended alarms for a DMS Replication Instance. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { DmsReplicationInstanceRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationInstanceRecommendedAlarmsConfig: DmsReplicationInstanceRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configFreeableMemoryAlarm | DmsFreeableMemoryAlarmConfig | The configuration for the FreeableMemory alarm. | | configFreeStorageSpaceAlarm | DmsFreeStorageSpaceAlarmConfig | The configuration for the FreeStorageSpace alarm. | | configCpuUtilizationAlarm | DmsCpuUtilizationAlarmConfig | The configuration for the CpuUtilization alarm. | | configSwapUsageAlarm | DmsSwapUsageAlarmConfig | The configuration for the SwapUsage alarm. | | configWriteIopsAlarm | DmsWriteIopsAlarmConfig | The configuration for the WriteIops alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | DmsReplicationInstanceRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configFreeableMemoryAlarm`^Required ```typescript public readonly configFreeableMemoryAlarm: DmsFreeableMemoryAlarmConfig; ``` - *Type:* DmsFreeableMemoryAlarmConfig The configuration for the FreeableMemory alarm. --- ##### `configFreeStorageSpaceAlarm`^Required ```typescript public readonly configFreeStorageSpaceAlarm: DmsFreeStorageSpaceAlarmConfig; ``` - *Type:* DmsFreeStorageSpaceAlarmConfig The configuration for the FreeStorageSpace alarm. --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: DmsCpuUtilizationAlarmConfig; ``` - *Type:* DmsCpuUtilizationAlarmConfig The configuration for the CpuUtilization alarm. --- ##### `configSwapUsageAlarm`^Optional ```typescript public readonly configSwapUsageAlarm: DmsSwapUsageAlarmConfig; ``` - *Type:* DmsSwapUsageAlarmConfig The configuration for the SwapUsage alarm. --- ##### `configWriteIopsAlarm`^Optional ```typescript public readonly configWriteIopsAlarm: DmsWriteIopsAlarmConfig; ``` - *Type:* DmsWriteIopsAlarmConfig The configuration for the WriteIops alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: DmsReplicationInstanceRecommendedAlarmsMetrics[]; ``` - *Type:* DmsReplicationInstanceRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### DmsReplicationInstanceRecommendedAlarmsProps Properties for the DmsReplicationInstanceRecommendedAlarms construct. #### Initializer ```typescript import { DmsReplicationInstanceRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationInstanceRecommendedAlarmsProps: DmsReplicationInstanceRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configFreeableMemoryAlarm | DmsFreeableMemoryAlarmConfig | The configuration for the FreeableMemory alarm. | | configFreeStorageSpaceAlarm | DmsFreeStorageSpaceAlarmConfig | The configuration for the FreeStorageSpace alarm. | | configCpuUtilizationAlarm | DmsCpuUtilizationAlarmConfig | The configuration for the CpuUtilization alarm. | | configSwapUsageAlarm | DmsSwapUsageAlarmConfig | The configuration for the SwapUsage alarm. | | configWriteIopsAlarm | DmsWriteIopsAlarmConfig | The configuration for the WriteIops alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | DmsReplicationInstanceRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | replicationInstance | aws-cdk-lib.aws_dms.CfnReplicationInstance | The DMS Replication Instance to monitor. | --- ##### `configFreeableMemoryAlarm`^Required ```typescript public readonly configFreeableMemoryAlarm: DmsFreeableMemoryAlarmConfig; ``` - *Type:* DmsFreeableMemoryAlarmConfig The configuration for the FreeableMemory alarm. --- ##### `configFreeStorageSpaceAlarm`^Required ```typescript public readonly configFreeStorageSpaceAlarm: DmsFreeStorageSpaceAlarmConfig; ``` - *Type:* DmsFreeStorageSpaceAlarmConfig The configuration for the FreeStorageSpace alarm. --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: DmsCpuUtilizationAlarmConfig; ``` - *Type:* DmsCpuUtilizationAlarmConfig The configuration for the CpuUtilization alarm. --- ##### `configSwapUsageAlarm`^Optional ```typescript public readonly configSwapUsageAlarm: DmsSwapUsageAlarmConfig; ``` - *Type:* DmsSwapUsageAlarmConfig The configuration for the SwapUsage alarm. --- ##### `configWriteIopsAlarm`^Optional ```typescript public readonly configWriteIopsAlarm: DmsWriteIopsAlarmConfig; ``` - *Type:* DmsWriteIopsAlarmConfig The configuration for the WriteIops alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: DmsReplicationInstanceRecommendedAlarmsMetrics[]; ``` - *Type:* DmsReplicationInstanceRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `replicationInstance`^Required ```typescript public readonly replicationInstance: CfnReplicationInstance; ``` - *Type:* aws-cdk-lib.aws_dms.CfnReplicationInstance The DMS Replication Instance to monitor. --- ### DmsReplicationInstanceSwapUsageAlarmProps The properties for the DmsReplicationInstanceSwapUsageAlarm construct. #### Initializer ```typescript import { DmsReplicationInstanceSwapUsageAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationInstanceSwapUsageAlarmProps: DmsReplicationInstanceSwapUsageAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicationInstance | aws-cdk-lib.aws_dms.CfnReplicationInstance | The DMS Replication Instance to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator to use for the alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `replicationInstance`^Required ```typescript public readonly replicationInstance: CfnReplicationInstance; ``` - *Type:* aws-cdk-lib.aws_dms.CfnReplicationInstance The DMS Replication Instance to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 (standard deviation for anomaly detection) The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high swap usage for the DMS Replication Instance. High swap usage can indicate memory pressure or performance issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - SwapUsage' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* GREATER_THAN_UPPER_THRESHOLD (for detecting high swap usage indicating memory pressure) The comparison operator to use for the alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 (allow for some variance while still detecting issues) The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 (to avoid false alarms from temporary fluctuations) The number of periods over which data is compared to the specified threshold. --- ### DmsReplicationInstanceWriteIopsAlarmProps The properties for the DmsReplicationInstanceWriteIopsAlarm construct. #### Initializer ```typescript import { DmsReplicationInstanceWriteIopsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationInstanceWriteIopsAlarmProps: DmsReplicationInstanceWriteIopsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicationInstance | aws-cdk-lib.aws_dms.CfnReplicationInstance | The DMS Replication Instance to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The number of write I/O operations per second against which the specified statistic is compared. | --- ##### `replicationInstance`^Required ```typescript public readonly replicationInstance: CfnReplicationInstance; ``` - *Type:* aws-cdk-lib.aws_dms.CfnReplicationInstance The DMS Replication Instance to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high write IOPS for the DMS Replication Instance. High write IOPS can indicate heavy write activity or potential I/O bottlenecks. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - WriteIOPS' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1000 The number of write I/O operations per second against which the specified statistic is compared. High write IOPS can indicate heavy write activity or potential performance bottlenecks. Consider your normal workload patterns when setting this threshold. --- ### DmsReplicationTaskAlarmProps The common properties for the DMS Replication Task alarms. #### Initializer ```typescript import { DmsReplicationTaskAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationTaskAlarmProps: DmsReplicationTaskAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicationTask | ReplicationTask | The DMS Replication Task to monitor. | --- ##### `replicationTask`^Required ```typescript public readonly replicationTask: ReplicationTask; ``` - *Type:* ReplicationTask The DMS Replication Task to monitor. --- ### DmsReplicationTaskCdcLatencySourceAlarmProps The properties for the DmsReplicationTaskCdcLatencySourceAlarm construct. #### Initializer ```typescript import { DmsReplicationTaskCdcLatencySourceAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationTaskCdcLatencySourceAlarmProps: DmsReplicationTaskCdcLatencySourceAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicationTask | ReplicationTask | The DMS Replication Task to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator to use for the alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The latency threshold in seconds. | --- ##### `replicationTask`^Required ```typescript public readonly replicationTask: ReplicationTask; ``` - *Type:* ReplicationTask The DMS Replication Task to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm monitors CDC latency from the source database. High values may indicate replication lag or source database performance issues. This can affect data freshness in real-time applications. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationTaskIdentifier + ' - CDCLatencySource' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* GREATER_THAN_THRESHOLD (for detecting high latency issues) The comparison operator to use for the alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 (allow for some variance while still detecting issues) The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 (to avoid false alarms from temporary fluctuations) The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 300 (5 minutes - for detecting high latency issues) The latency threshold in seconds. This alarm can be used to detect: - High latency indicating replication lag or source database performance issues - Potential data freshness problems affecting real-time applications Consider your application's tolerance for data lag when setting this threshold. --- ### DmsReplicationTaskCdcLatencyTargetAlarmProps The properties for the DmsReplicationTaskCdcLatencyTargetAlarm construct. #### Initializer ```typescript import { DmsReplicationTaskCdcLatencyTargetAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationTaskCdcLatencyTargetAlarmProps: DmsReplicationTaskCdcLatencyTargetAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | replicationTask | ReplicationTask | The DMS Replication Task to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator to use for the alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The latency threshold in seconds. | --- ##### `replicationTask`^Required ```typescript public readonly replicationTask: ReplicationTask; ``` - *Type:* ReplicationTask The DMS Replication Task to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm monitors CDC latency to the target database. High values may indicate replication lag or target database performance issues. This can affect data consistency in downstream applications. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationTaskIdentifier + ' - CDCLatencyTarget' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* GREATER_THAN_THRESHOLD (for detecting high latency issues) The comparison operator to use for the alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 (allow for some variance while still detecting issues) The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 (to avoid false alarms from temporary fluctuations) The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 300 (5 minutes - for detecting high latency issues) The latency threshold in seconds. This alarm can be used to detect: - High latency indicating target database performance issues or replication lag - Potential data consistency problems affecting downstream applications Consider your application's tolerance for data lag when setting this threshold. --- ### DmsReplicationTaskRecommendedAlarmsConfig Configurations for the recommended alarms for a DMS Replication Task. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { DmsReplicationTaskRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationTaskRecommendedAlarmsConfig: DmsReplicationTaskRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configCdcLatencySourceAlarm | DmsCdcLatencySourceAlarmConfig | The configuration for the CDCLatencySource alarm. | | configCdcLatencyTargetAlarm | DmsCdcLatencyTargetAlarmConfig | The configuration for the CDCLatencyTarget alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | DmsReplicationTaskRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configCdcLatencySourceAlarm`^Optional ```typescript public readonly configCdcLatencySourceAlarm: DmsCdcLatencySourceAlarmConfig; ``` - *Type:* DmsCdcLatencySourceAlarmConfig The configuration for the CDCLatencySource alarm. --- ##### `configCdcLatencyTargetAlarm`^Optional ```typescript public readonly configCdcLatencyTargetAlarm: DmsCdcLatencyTargetAlarmConfig; ``` - *Type:* DmsCdcLatencyTargetAlarmConfig The configuration for the CDCLatencyTarget alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: DmsReplicationTaskRecommendedAlarmsMetrics[]; ``` - *Type:* DmsReplicationTaskRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### DmsReplicationTaskRecommendedAlarmsProps Properties for the DmsReplicationTaskRecommendedAlarms construct. #### Initializer ```typescript import { DmsReplicationTaskRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsReplicationTaskRecommendedAlarmsProps: DmsReplicationTaskRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configCdcLatencySourceAlarm | DmsCdcLatencySourceAlarmConfig | The configuration for the CDCLatencySource alarm. | | configCdcLatencyTargetAlarm | DmsCdcLatencyTargetAlarmConfig | The configuration for the CDCLatencyTarget alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | DmsReplicationTaskRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | replicationTask | ReplicationTask | The DMS Replication Task to monitor. | --- ##### `configCdcLatencySourceAlarm`^Optional ```typescript public readonly configCdcLatencySourceAlarm: DmsCdcLatencySourceAlarmConfig; ``` - *Type:* DmsCdcLatencySourceAlarmConfig The configuration for the CDCLatencySource alarm. --- ##### `configCdcLatencyTargetAlarm`^Optional ```typescript public readonly configCdcLatencyTargetAlarm: DmsCdcLatencyTargetAlarmConfig; ``` - *Type:* DmsCdcLatencyTargetAlarmConfig The configuration for the CDCLatencyTarget alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: DmsReplicationTaskRecommendedAlarmsMetrics[]; ``` - *Type:* DmsReplicationTaskRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `replicationTask`^Required ```typescript public readonly replicationTask: ReplicationTask; ``` - *Type:* ReplicationTask The DMS Replication Task to monitor. --- ### DmsSwapUsageAlarmConfig Configuration for the SwapUsage alarm. #### Initializer ```typescript import { DmsSwapUsageAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsSwapUsageAlarmConfig: DmsSwapUsageAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stdDevs | number | The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator to use for the alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 (standard deviation for anomaly detection) The width of the anomaly detection band, expressed as a number of standard deviations from the metric's mean. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high swap usage for the DMS Replication Instance. High swap usage can indicate memory pressure or performance issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - SwapUsage' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* GREATER_THAN_UPPER_THRESHOLD (for detecting high swap usage indicating memory pressure) The comparison operator to use for the alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 (allow for some variance while still detecting issues) The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 (to avoid false alarms from temporary fluctuations) The number of periods over which data is compared to the specified threshold. --- ### DmsWriteIopsAlarmConfig Configuration for the WriteIops alarm. #### Initializer ```typescript import { DmsWriteIopsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dmsWriteIopsAlarmConfig: DmsWriteIopsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The number of write I/O operations per second against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) for regular alarms, Duration.minutes(5) for anomaly detection and throughput alarms The period over which the specified statistic is applied. Different alarm types may have different optimal default periods: - Regular alarms: 1 minute (for responsive monitoring) - Anomaly detection alarms: 5 minutes (for stable ML model training) - CDC/throughput alarms: 5 minutes (for trend analysis) --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high write IOPS for the DMS Replication Instance. High write IOPS can indicate heavy write activity or potential I/O bottlenecks. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* replicationInstanceIdentifier + ' - WriteIOPS' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1000 The number of write I/O operations per second against which the specified statistic is compared. High write IOPS can indicate heavy write activity or potential performance bottlenecks. Consider your normal workload patterns when setting this threshold. --- ### DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig Configuration for the AgeOfOldestUnreplicatedRecord alarm. #### Initializer ```typescript import { DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig: DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to the desired replication delay measured in milliseconds. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the desired replication delay measured in milliseconds. This value depends on your workload's requirements and expected performance. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can monitor unsuccessful replication attempts and the resulting delay in replication to the Kinesis data stream. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - AgeOfOldestUnreplicatedRecord' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ### DynamoDbAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { DynamoDbAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbAlarmBaseConfig: DynamoDbAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### DynamoDbFailedToReplicateRecordCountAlarmConfig Configuration for the FailedToReplicateRecordCount alarm. #### Initializer ```typescript import { DynamoDbFailedToReplicateRecordCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbFailedToReplicateRecordCountAlarmConfig: DynamoDbFailedToReplicateRecordCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | Set the threshold to 0 to detect any records that DynamoDB failed to replicate. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can monitor the number of records that DynamoDB failed to replicate to your Kinesis data stream because of the item size limit of Kinesis Data Streams. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - FailedToReplicateRecordCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 1 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold to 0 to detect any records that DynamoDB failed to replicate. --- ### DynamoDbReadThrottleEventsAlarmConfig Configuration for the ReadThrottleEvents alarm. #### Initializer ```typescript import { DynamoDbReadThrottleEventsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbReadThrottleEventsAlarmConfig: DynamoDbReadThrottleEventsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to the expected read traffic for the DynamoDB table, accounting for an acceptable level of throttling. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the expected read traffic for the DynamoDB table, accounting for an acceptable level of throttling. It is important to monitor whether you are under provisioned and not causing consistent throttling. You can also analyze historical data to find the acceptable throttling level for the application workload, and then tune the threshold to be higher than your usual throttling level. Throttled requests should be retried by the application or service as they are transient. Therefore, a very low threshold may cause the alarm to be too sensitive, causing unwanted state transitions. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect sustained throttling for read requests to the DynamoDB table. Sustained throttling of read requests can negatively impact your workload read operations and reduce the overall efficiency of the system. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - ReadThrottleEvents' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### DynamoDbSystemErrorsAlarmConfig Configuration for the SystemErrors alarm. #### Initializer ```typescript import { DynamoDbSystemErrorsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbSystemErrorsAlarmConfig: DynamoDbSystemErrorsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to the expected traffic, accounting for an acceptable level of system errors. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the expected traffic, accounting for an acceptable level of system errors. You can also analyze historical data to find the acceptable error count for the application workload, and then tune the threshold accordingly. System errors should be retried by the application/service as they are transient. Therefore, a very low threshold might cause the alarm to be too sensitive, causing unwanted state transitions. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect sustained system errors for the DynamoDB table requests. System errors indicate internal service errors from DynamoDB and helps correlate to the issue that the client is having. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - SystemErrors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps The properties for the DynamoDbTableAgeOfOldestUnreplicatedRecordAlarm construct. #### Initializer ```typescript import { DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps: DynamoDbTableAgeOfOldestUnreplicatedRecordAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | aws-cdk-lib.aws_dynamodb.Table | The DynamoDb Table to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to the desired replication delay measured in milliseconds. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table The DynamoDb Table to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the desired replication delay measured in milliseconds. This value depends on your workload's requirements and expected performance. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can monitor unsuccessful replication attempts and the resulting delay in replication to the Kinesis data stream. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - AgeOfOldestUnreplicatedRecord' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ### DynamoDbTableAlarmProps The common properties for the DynamoDb Table alarms. #### Initializer ```typescript import { DynamoDbTableAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbTableAlarmProps: DynamoDbTableAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | aws-cdk-lib.aws_dynamodb.Table | The DynamoDb Table to monitor. | --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table The DynamoDb Table to monitor. --- ### DynamoDbTableFailedToReplicateRecordCountAlarmProps The properties for the DynamoDbTableFailedToReplicateRecordCountAlarm construct. #### Initializer ```typescript import { DynamoDbTableFailedToReplicateRecordCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbTableFailedToReplicateRecordCountAlarmProps: DynamoDbTableFailedToReplicateRecordCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | aws-cdk-lib.aws_dynamodb.Table | The DynamoDb Table to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | Set the threshold to 0 to detect any records that DynamoDB failed to replicate. | --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table The DynamoDb Table to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can monitor the number of records that DynamoDB failed to replicate to your Kinesis data stream because of the item size limit of Kinesis Data Streams. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - FailedToReplicateRecordCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 1 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 1 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold to 0 to detect any records that DynamoDB failed to replicate. --- ### DynamoDbTableReadThrottleEventsAlarmProps The properties for the DynamoDbTableReadThrottleEventsAlarm construct. #### Initializer ```typescript import { DynamoDbTableReadThrottleEventsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbTableReadThrottleEventsAlarmProps: DynamoDbTableReadThrottleEventsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | aws-cdk-lib.aws_dynamodb.Table | The DynamoDb Table to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to the expected read traffic for the DynamoDB table, accounting for an acceptable level of throttling. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table The DynamoDb Table to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the expected read traffic for the DynamoDB table, accounting for an acceptable level of throttling. It is important to monitor whether you are under provisioned and not causing consistent throttling. You can also analyze historical data to find the acceptable throttling level for the application workload, and then tune the threshold to be higher than your usual throttling level. Throttled requests should be retried by the application or service as they are transient. Therefore, a very low threshold may cause the alarm to be too sensitive, causing unwanted state transitions. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect sustained throttling for read requests to the DynamoDB table. Sustained throttling of read requests can negatively impact your workload read operations and reduce the overall efficiency of the system. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - ReadThrottleEvents' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### DynamoDbTableRecommendedAlarmsConfig Configurations for the recommended alarms for an DynamoDb Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { DynamoDbTableRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbTableRecommendedAlarmsConfig: DynamoDbTableRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configReadThrottleEventsAlarm | DynamoDbReadThrottleEventsAlarmConfig | The configuration for the ReadThrottleEvents alarm. | | configSystemErrorsAlarm | DynamoDbSystemErrorsAlarmConfig | The configuration for the SystemErrors alarm. | | configWriteThrottleEventsAlarm | DynamoDbWriteThrottleEventsAlarmConfig | The configuration for the WriteThrottleEvents alarm. | | configAgeOfOldestUnreplicatedRecordAlarm | DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig | The configuration for the AgeOfOldestUnreplicatedRecord alarm. | | configFailedToReplicateRecordCountAlarm | DynamoDbFailedToReplicateRecordCountAlarmConfig | The configuration for the FailedToReplicateRecordCount alarm. | | configThrottledPutRecordCountAlarm | DynamoDbThrottledPutRecordCountAlarmConfig | The configuration for the ThrottledPutRecordCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | DynamoDbRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configReadThrottleEventsAlarm`^Required ```typescript public readonly configReadThrottleEventsAlarm: DynamoDbReadThrottleEventsAlarmConfig; ``` - *Type:* DynamoDbReadThrottleEventsAlarmConfig The configuration for the ReadThrottleEvents alarm. --- ##### `configSystemErrorsAlarm`^Required ```typescript public readonly configSystemErrorsAlarm: DynamoDbSystemErrorsAlarmConfig; ``` - *Type:* DynamoDbSystemErrorsAlarmConfig The configuration for the SystemErrors alarm. --- ##### `configWriteThrottleEventsAlarm`^Required ```typescript public readonly configWriteThrottleEventsAlarm: DynamoDbWriteThrottleEventsAlarmConfig; ``` - *Type:* DynamoDbWriteThrottleEventsAlarmConfig The configuration for the WriteThrottleEvents alarm. --- ##### `configAgeOfOldestUnreplicatedRecordAlarm`^Optional ```typescript public readonly configAgeOfOldestUnreplicatedRecordAlarm: DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig; ``` - *Type:* DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig The configuration for the AgeOfOldestUnreplicatedRecord alarm. --- ##### `configFailedToReplicateRecordCountAlarm`^Optional ```typescript public readonly configFailedToReplicateRecordCountAlarm: DynamoDbFailedToReplicateRecordCountAlarmConfig; ``` - *Type:* DynamoDbFailedToReplicateRecordCountAlarmConfig The configuration for the FailedToReplicateRecordCount alarm. --- ##### `configThrottledPutRecordCountAlarm`^Optional ```typescript public readonly configThrottledPutRecordCountAlarm: DynamoDbThrottledPutRecordCountAlarmConfig; ``` - *Type:* DynamoDbThrottledPutRecordCountAlarmConfig The configuration for the ThrottledPutRecordCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: DynamoDbRecommendedAlarmsMetrics[]; ``` - *Type:* DynamoDbRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### DynamoDbTableRecommendedAlarmsProps Properties for the DynamoDbTableRecommendedAlarms construct. #### Initializer ```typescript import { DynamoDbTableRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbTableRecommendedAlarmsProps: DynamoDbTableRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configReadThrottleEventsAlarm | DynamoDbReadThrottleEventsAlarmConfig | The configuration for the ReadThrottleEvents alarm. | | configSystemErrorsAlarm | DynamoDbSystemErrorsAlarmConfig | The configuration for the SystemErrors alarm. | | configWriteThrottleEventsAlarm | DynamoDbWriteThrottleEventsAlarmConfig | The configuration for the WriteThrottleEvents alarm. | | configAgeOfOldestUnreplicatedRecordAlarm | DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig | The configuration for the AgeOfOldestUnreplicatedRecord alarm. | | configFailedToReplicateRecordCountAlarm | DynamoDbFailedToReplicateRecordCountAlarmConfig | The configuration for the FailedToReplicateRecordCount alarm. | | configThrottledPutRecordCountAlarm | DynamoDbThrottledPutRecordCountAlarmConfig | The configuration for the ThrottledPutRecordCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | DynamoDbRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | table | aws-cdk-lib.aws_dynamodb.Table | The DynamoDb Table to monitor. | --- ##### `configReadThrottleEventsAlarm`^Required ```typescript public readonly configReadThrottleEventsAlarm: DynamoDbReadThrottleEventsAlarmConfig; ``` - *Type:* DynamoDbReadThrottleEventsAlarmConfig The configuration for the ReadThrottleEvents alarm. --- ##### `configSystemErrorsAlarm`^Required ```typescript public readonly configSystemErrorsAlarm: DynamoDbSystemErrorsAlarmConfig; ``` - *Type:* DynamoDbSystemErrorsAlarmConfig The configuration for the SystemErrors alarm. --- ##### `configWriteThrottleEventsAlarm`^Required ```typescript public readonly configWriteThrottleEventsAlarm: DynamoDbWriteThrottleEventsAlarmConfig; ``` - *Type:* DynamoDbWriteThrottleEventsAlarmConfig The configuration for the WriteThrottleEvents alarm. --- ##### `configAgeOfOldestUnreplicatedRecordAlarm`^Optional ```typescript public readonly configAgeOfOldestUnreplicatedRecordAlarm: DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig; ``` - *Type:* DynamoDbAgeOfOldestUnreplicatedRecordAlarmConfig The configuration for the AgeOfOldestUnreplicatedRecord alarm. --- ##### `configFailedToReplicateRecordCountAlarm`^Optional ```typescript public readonly configFailedToReplicateRecordCountAlarm: DynamoDbFailedToReplicateRecordCountAlarmConfig; ``` - *Type:* DynamoDbFailedToReplicateRecordCountAlarmConfig The configuration for the FailedToReplicateRecordCount alarm. --- ##### `configThrottledPutRecordCountAlarm`^Optional ```typescript public readonly configThrottledPutRecordCountAlarm: DynamoDbThrottledPutRecordCountAlarmConfig; ``` - *Type:* DynamoDbThrottledPutRecordCountAlarmConfig The configuration for the ThrottledPutRecordCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: DynamoDbRecommendedAlarmsMetrics[]; ``` - *Type:* DynamoDbRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table The DynamoDb Table to monitor. --- ### DynamoDbTableSystemErrorsAlarmProps The properties for the DynamoDbTableSystemErrorsAlarm construct. #### Initializer ```typescript import { DynamoDbTableSystemErrorsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbTableSystemErrorsAlarmProps: DynamoDbTableSystemErrorsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | aws-cdk-lib.aws_dynamodb.Table | The DynamoDb Table to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to the expected traffic, accounting for an acceptable level of system errors. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table The DynamoDb Table to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the expected traffic, accounting for an acceptable level of system errors. You can also analyze historical data to find the acceptable error count for the application workload, and then tune the threshold accordingly. System errors should be retried by the application/service as they are transient. Therefore, a very low threshold might cause the alarm to be too sensitive, causing unwanted state transitions. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect sustained system errors for the DynamoDB table requests. System errors indicate internal service errors from DynamoDB and helps correlate to the issue that the client is having. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - SystemErrors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### DynamoDbTableThrottledPutRecordCountAlarmProps The properties for the DynamoDbTableThrottledPutRecordCountAlarm construct. #### Initializer ```typescript import { DynamoDbTableThrottledPutRecordCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbTableThrottledPutRecordCountAlarmProps: DynamoDbTableThrottledPutRecordCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | aws-cdk-lib.aws_dynamodb.Table | The DynamoDb Table to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | You might experience some throttling during exceptional usage peaks, but throttled records should remain as low as possible to avoid higher replication latency (DynamoDB retries sending throttled records to the Kinesis data stream). | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table The DynamoDb Table to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number You might experience some throttling during exceptional usage peaks, but throttled records should remain as low as possible to avoid higher replication latency (DynamoDB retries sending throttled records to the Kinesis data stream). Set the threshold to a number which can help you catch regular excessive throttling. You can also analyze historical data of this metric to find the acceptable throttling rates for the application workload. Tune the threshold to a value that the application can tolerate based on your use case. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can monitor the number of records that that were throttled by your Kinesis data stream because of insufficient Kinesis data stream capacity. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - ThrottledPutRecordCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 10 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 10 The number of periods over which data is compared to the specified threshold. --- ### DynamoDbTableWriteThrottleEventsAlarmProps The properties for the DynamoDbTableWriteThrottleEventsAlarm construct. #### Initializer ```typescript import { DynamoDbTableWriteThrottleEventsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbTableWriteThrottleEventsAlarmProps: DynamoDbTableWriteThrottleEventsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | table | aws-cdk-lib.aws_dynamodb.Table | The DynamoDb Table to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to the expected write traffic for the DynamoDB table, accounting for an acceptable level of throttling. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `table`^Required ```typescript public readonly table: Table; ``` - *Type:* aws-cdk-lib.aws_dynamodb.Table The DynamoDb Table to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the expected write traffic for the DynamoDB table, accounting for an acceptable level of throttling. It is important to monitor if you are under provisioned and not causing consistent throttling. You can also analyze historical data to find the acceptable level of throttling for the application workload, and then tune the threshold to a value higher than your usual acceptable throttling level. Throttled requests should be retried by the application/service as they are transient. Therefore, a very low threshold might cause the alarm to be too sensitive, causing unwanted state transitions. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect sustained throttling for write requests to the DynamoDB table. Sustained throttling of write requests can negatively impact your workload write operations and reduce the overall efficiency of the system. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - WriteThrottleEvents' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### DynamoDbThrottledPutRecordCountAlarmConfig Configuration for the ThrottledPutRecordCount alarm. #### Initializer ```typescript import { DynamoDbThrottledPutRecordCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbThrottledPutRecordCountAlarmConfig: DynamoDbThrottledPutRecordCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | You might experience some throttling during exceptional usage peaks, but throttled records should remain as low as possible to avoid higher replication latency (DynamoDB retries sending throttled records to the Kinesis data stream). | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number You might experience some throttling during exceptional usage peaks, but throttled records should remain as low as possible to avoid higher replication latency (DynamoDB retries sending throttled records to the Kinesis data stream). Set the threshold to a number which can help you catch regular excessive throttling. You can also analyze historical data of this metric to find the acceptable throttling rates for the application workload. Tune the threshold to a value that the application can tolerate based on your use case. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can monitor the number of records that that were throttled by your Kinesis data stream because of insufficient Kinesis data stream capacity. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - ThrottledPutRecordCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 10 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 10 The number of periods over which data is compared to the specified threshold. --- ### DynamoDbWriteThrottleEventsAlarmConfig Configuration for the WriteThrottleEvents alarm. #### Initializer ```typescript import { DynamoDbWriteThrottleEventsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const dynamoDbWriteThrottleEventsAlarmConfig: DynamoDbWriteThrottleEventsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to the expected write traffic for the DynamoDB table, accounting for an acceptable level of throttling. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the expected write traffic for the DynamoDB table, accounting for an acceptable level of throttling. It is important to monitor if you are under provisioned and not causing consistent throttling. You can also analyze historical data to find the acceptable level of throttling for the application workload, and then tune the threshold to a value higher than your usual acceptable throttling level. Throttled requests should be retried by the application/service as they are transient. Therefore, a very low threshold might cause the alarm to be too sensitive, causing unwanted state transitions. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect sustained throttling for write requests to the DynamoDB table. Sustained throttling of write requests can negatively impact your workload write operations and reduce the overall efficiency of the system. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* tableName + ' - WriteThrottleEvents' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### Ec2AlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { Ec2AlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ec2AlarmBaseConfig: Ec2AlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### Ec2CpuUtilizationAlarmConfig Configuration for the CPUUtilization alarm. #### Initializer ```typescript import { Ec2CpuUtilizationAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ec2CpuUtilizationAlarmConfig: Ec2CpuUtilizationAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | Typically, you can set the threshold for CPU utilization to 70-80%. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high CPU utilization. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* instanceId + ' - CPUUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 80 Typically, you can set the threshold for CPU utilization to 70-80%. However, you can adjust this value based on your acceptable performance level and workload characteristics. For some systems, consistently high CPU utilization may be normal and not indicate a problem, while for others, it may be cause of concern. Analyze historical CPU utilization data to identify the usage, find what CPU utilization is acceptable for your system, and set the threshold accordingly. --- ### Ec2InstanceAlarmProps The common properties for the EC2 Instance alarms. #### Initializer ```typescript import { Ec2InstanceAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ec2InstanceAlarmProps: Ec2InstanceAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instance | aws-cdk-lib.aws_ec2.Instance | The EC2 Instance to monitor. | --- ##### `instance`^Required ```typescript public readonly instance: Instance; ``` - *Type:* aws-cdk-lib.aws_ec2.Instance The EC2 Instance to monitor. --- ### Ec2InstanceCpuUtilizationAlarmProps The properties for the Ec2InstanceCpuUtilizationAlarm construct. #### Initializer ```typescript import { Ec2InstanceCpuUtilizationAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ec2InstanceCpuUtilizationAlarmProps: Ec2InstanceCpuUtilizationAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instance | aws-cdk-lib.aws_ec2.Instance | The EC2 Instance to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | Typically, you can set the threshold for CPU utilization to 70-80%. | --- ##### `instance`^Required ```typescript public readonly instance: Instance; ``` - *Type:* aws-cdk-lib.aws_ec2.Instance The EC2 Instance to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high CPU utilization. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* instanceId + ' - CPUUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 80 Typically, you can set the threshold for CPU utilization to 70-80%. However, you can adjust this value based on your acceptable performance level and workload characteristics. For some systems, consistently high CPU utilization may be normal and not indicate a problem, while for others, it may be cause of concern. Analyze historical CPU utilization data to identify the usage, find what CPU utilization is acceptable for your system, and set the threshold accordingly. --- ### Ec2InstanceRecommendedAlarmsConfig Configurations for the recommended alarms for an EC2 Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { Ec2InstanceRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ec2InstanceRecommendedAlarmsConfig: Ec2InstanceRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configCpuUtilizationAlarm | Ec2CpuUtilizationAlarmConfig | The configuration for the CPUUtilization alarm. | | configStatusCheckFailedAlarm | Ec2StatusCheckFailedAlarmConfig | The configuration for the StatusCheckFailed alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | Ec2RecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: Ec2CpuUtilizationAlarmConfig; ``` - *Type:* Ec2CpuUtilizationAlarmConfig The configuration for the CPUUtilization alarm. --- ##### `configStatusCheckFailedAlarm`^Optional ```typescript public readonly configStatusCheckFailedAlarm: Ec2StatusCheckFailedAlarmConfig; ``` - *Type:* Ec2StatusCheckFailedAlarmConfig The configuration for the StatusCheckFailed alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: Ec2RecommendedAlarmsMetrics[]; ``` - *Type:* Ec2RecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### Ec2InstanceRecommendedAlarmsProps Properties for the Ec2InstanceRecommendedAlarms construct. #### Initializer ```typescript import { Ec2InstanceRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ec2InstanceRecommendedAlarmsProps: Ec2InstanceRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configCpuUtilizationAlarm | Ec2CpuUtilizationAlarmConfig | The configuration for the CPUUtilization alarm. | | configStatusCheckFailedAlarm | Ec2StatusCheckFailedAlarmConfig | The configuration for the StatusCheckFailed alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | Ec2RecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | instance | aws-cdk-lib.aws_ec2.Instance | The EC2 Instance to monitor. | --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: Ec2CpuUtilizationAlarmConfig; ``` - *Type:* Ec2CpuUtilizationAlarmConfig The configuration for the CPUUtilization alarm. --- ##### `configStatusCheckFailedAlarm`^Optional ```typescript public readonly configStatusCheckFailedAlarm: Ec2StatusCheckFailedAlarmConfig; ``` - *Type:* Ec2StatusCheckFailedAlarmConfig The configuration for the StatusCheckFailed alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: Ec2RecommendedAlarmsMetrics[]; ``` - *Type:* Ec2RecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `instance`^Required ```typescript public readonly instance: Instance; ``` - *Type:* aws-cdk-lib.aws_ec2.Instance The EC2 Instance to monitor. --- ### Ec2InstanceStatusCheckFailedAlarmProps The properties for the Ec2InstanceStatusCheckFailedAlarm construct. #### Initializer ```typescript import { Ec2InstanceStatusCheckFailedAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ec2InstanceStatusCheckFailedAlarmProps: Ec2InstanceStatusCheckFailedAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | instance | aws-cdk-lib.aws_ec2.Instance | The EC2 Instance to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | When a status check fails, the value of this metric is 1. | --- ##### `instance`^Required ```typescript public readonly instance: Instance; ``` - *Type:* aws-cdk-lib.aws_ec2.Instance The EC2 Instance to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect the underlying problems with instances, including both system status check failures and instance status check failures. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* instanceId + ' - StatusCheckFailed' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 2 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 When a status check fails, the value of this metric is 1. The threshold is set so that whenever the status check fails, the alarm is in ALARM state. --- ### Ec2StatusCheckFailedAlarmConfig Configuration for the StatusCheckFailed alarm. #### Initializer ```typescript import { Ec2StatusCheckFailedAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ec2StatusCheckFailedAlarmConfig: Ec2StatusCheckFailedAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | When a status check fails, the value of this metric is 1. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect the underlying problems with instances, including both system status check failures and instance status check failures. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* instanceId + ' - StatusCheckFailed' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 2 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 When a status check fails, the value of this metric is 1. The threshold is set so that whenever the status check fails, the alarm is in ALARM state. --- ### EcsAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { EcsAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsAlarmBaseConfig: EcsAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### EcsCpuUtilizationAlarmConfig Configuration for the CpuUtilization alarm. #### Initializer ```typescript import { EcsCpuUtilizationAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsCpuUtilizationAlarmConfig: EcsCpuUtilizationAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The percentage (0-100) value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high CPU utilization for the ECS service. Consistent high CPU utilization can indicate a resource bottleneck or application performance problems. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* clusterName + ' - ' + serviceName + ' - CPUUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 The percentage (0-100) value against which the specified statistic is compared. The service metrics for CPU utilization might exceed 100% utilization. However, we recommend that you monitor the metric for high CPU utilization to avoid impacting other services. Set the threshold to about 90-95%. We recommend that you update your task definitions to reflect actual usage to prevent future issues with other services. --- ### EcsEphemeralStorageUtilizedAlarmConfig Configuration for the EphemeralStorageUtilized alarm. #### Initializer ```typescript import { EcsEphemeralStorageUtilizedAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsEphemeralStorageUtilizedAlarmConfig: EcsEphemeralStorageUtilizedAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value in GB against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value in GB against which the specified statistic is compared. Set the threshold to about 90% of the ephemeral storage size. You can adjust this value based on your acceptable ephemeral storage utilization of the Fargate cluster. For some systems, a consistently high ephemeral storage utilized might be normal, while for others, it might lead to failure of the container. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high ephemeral storage usage for the Fargate cluster. Consistent high ephemeral storage utilized can indicate that the disk is full and it might lead to failure of the container. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* clusterName + ' - ' + serviceName + ' - EphemeralStorageUtilized' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### EcsMemoryUtilizationAlarmConfig Configuration for the MemoryUtilization alarm. #### Initializer ```typescript import { EcsMemoryUtilizationAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsMemoryUtilizationAlarmConfig: EcsMemoryUtilizationAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The percentage (0-100) value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high memory utilization for the ECS service. Consistent high memory utilization can indicate a resource bottleneck or application performance problems. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* clusterName + ' - ' + serviceName + ' - MemoryUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 The percentage (0-100) value against which the specified statistic is compared. The memory utilization is measured as the total memory in use by the tasks that belong to the service, divided by the total memory reserved for the tasks that belong to the service. --- ### EcsRunningTaskCountAlarmConfig Configuration for the RunningTaskCount alarm. #### Initializer ```typescript import { EcsRunningTaskCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsRunningTaskCountAlarmConfig: EcsRunningTaskCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect whether the number of running tasks are too low. A consistent low running task count can indicate ECS service deployment or performance issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* clusterName + ' - ' + serviceName + ' - RunningTaskCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You can adjust the threshold based on the minimum running task count of the ECS service. If the running task count is 0, the Amazon ECS service will be unavailable. --- ### EcsServiceAlarmProps The common properties for the ECS service alarms. #### Initializer ```typescript import { EcsServiceAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsServiceAlarmProps: EcsServiceAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | service | aws-cdk-lib.aws_ecs.FargateService | The ECS service to monitor. | --- ##### `service`^Required ```typescript public readonly service: FargateService; ``` - *Type:* aws-cdk-lib.aws_ecs.FargateService The ECS service to monitor. --- ### EcsServiceCpuUtilizationAlarmProps The properties for the EcsServiceCpuUtilizationAlarm construct. #### Initializer ```typescript import { EcsServiceCpuUtilizationAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsServiceCpuUtilizationAlarmProps: EcsServiceCpuUtilizationAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | service | aws-cdk-lib.aws_ecs.FargateService | The ECS service to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The percentage (0-100) value against which the specified statistic is compared. | --- ##### `service`^Required ```typescript public readonly service: FargateService; ``` - *Type:* aws-cdk-lib.aws_ecs.FargateService The ECS service to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high CPU utilization for the ECS service. Consistent high CPU utilization can indicate a resource bottleneck or application performance problems. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* clusterName + ' - ' + serviceName + ' - CPUUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 The percentage (0-100) value against which the specified statistic is compared. The service metrics for CPU utilization might exceed 100% utilization. However, we recommend that you monitor the metric for high CPU utilization to avoid impacting other services. Set the threshold to about 90-95%. We recommend that you update your task definitions to reflect actual usage to prevent future issues with other services. --- ### EcsServiceEphemeralStorageUtilizedAlarmProps The properties for the EcsServiceEphemeralStorageUtilizedAlarm construct. #### Initializer ```typescript import { EcsServiceEphemeralStorageUtilizedAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsServiceEphemeralStorageUtilizedAlarmProps: EcsServiceEphemeralStorageUtilizedAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | service | aws-cdk-lib.aws_ecs.FargateService | The ECS service to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value in GB against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `service`^Required ```typescript public readonly service: FargateService; ``` - *Type:* aws-cdk-lib.aws_ecs.FargateService The ECS service to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value in GB against which the specified statistic is compared. Set the threshold to about 90% of the ephemeral storage size. You can adjust this value based on your acceptable ephemeral storage utilization of the Fargate cluster. For some systems, a consistently high ephemeral storage utilized might be normal, while for others, it might lead to failure of the container. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high ephemeral storage usage for the Fargate cluster. Consistent high ephemeral storage utilized can indicate that the disk is full and it might lead to failure of the container. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* clusterName + ' - ' + serviceName + ' - EphemeralStorageUtilized' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### EcsServiceMemoryUtilizationAlarmProps The properties for the EcsServiceMemoryUtilizationAlarm construct. #### Initializer ```typescript import { EcsServiceMemoryUtilizationAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsServiceMemoryUtilizationAlarmProps: EcsServiceMemoryUtilizationAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | service | aws-cdk-lib.aws_ecs.FargateService | The ECS service to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The percentage (0-100) value against which the specified statistic is compared. | --- ##### `service`^Required ```typescript public readonly service: FargateService; ``` - *Type:* aws-cdk-lib.aws_ecs.FargateService The ECS service to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high memory utilization for the ECS service. Consistent high memory utilization can indicate a resource bottleneck or application performance problems. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* clusterName + ' - ' + serviceName + ' - MemoryUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 The percentage (0-100) value against which the specified statistic is compared. The memory utilization is measured as the total memory in use by the tasks that belong to the service, divided by the total memory reserved for the tasks that belong to the service. --- ### EcsServiceRecommendedAlarmsConfig Configurations for the recommended alarms for an ECS Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { EcsServiceRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsServiceRecommendedAlarmsConfig: EcsServiceRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configEphemeralStorageUtilizedAlarm | EcsEphemeralStorageUtilizedAlarmConfig | The configuration for the EphemeralStorageUtilized alarm. | | configCpuUtilizationAlarm | EcsCpuUtilizationAlarmConfig | The configuration for the CpuUtilization alarm. | | configMemoryUtilizationAlarm | EcsMemoryUtilizationAlarmConfig | The configuration for the MemoryUtilization alarm. | | configRunningTaskCountAlarm | EcsRunningTaskCountAlarmConfig | The configuration for the RunningTaskCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | EcsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configEphemeralStorageUtilizedAlarm`^Required ```typescript public readonly configEphemeralStorageUtilizedAlarm: EcsEphemeralStorageUtilizedAlarmConfig; ``` - *Type:* EcsEphemeralStorageUtilizedAlarmConfig The configuration for the EphemeralStorageUtilized alarm. --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: EcsCpuUtilizationAlarmConfig; ``` - *Type:* EcsCpuUtilizationAlarmConfig The configuration for the CpuUtilization alarm. --- ##### `configMemoryUtilizationAlarm`^Optional ```typescript public readonly configMemoryUtilizationAlarm: EcsMemoryUtilizationAlarmConfig; ``` - *Type:* EcsMemoryUtilizationAlarmConfig The configuration for the MemoryUtilization alarm. --- ##### `configRunningTaskCountAlarm`^Optional ```typescript public readonly configRunningTaskCountAlarm: EcsRunningTaskCountAlarmConfig; ``` - *Type:* EcsRunningTaskCountAlarmConfig The configuration for the RunningTaskCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: EcsRecommendedAlarmsMetrics[]; ``` - *Type:* EcsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### EcsServiceRecommendedAlarmsProps Properties for the EcsServiceRecommendedAlarms construct. #### Initializer ```typescript import { EcsServiceRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsServiceRecommendedAlarmsProps: EcsServiceRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configEphemeralStorageUtilizedAlarm | EcsEphemeralStorageUtilizedAlarmConfig | The configuration for the EphemeralStorageUtilized alarm. | | configCpuUtilizationAlarm | EcsCpuUtilizationAlarmConfig | The configuration for the CpuUtilization alarm. | | configMemoryUtilizationAlarm | EcsMemoryUtilizationAlarmConfig | The configuration for the MemoryUtilization alarm. | | configRunningTaskCountAlarm | EcsRunningTaskCountAlarmConfig | The configuration for the RunningTaskCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | EcsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | service | aws-cdk-lib.aws_ecs.FargateService | The ECS service to monitor. | --- ##### `configEphemeralStorageUtilizedAlarm`^Required ```typescript public readonly configEphemeralStorageUtilizedAlarm: EcsEphemeralStorageUtilizedAlarmConfig; ``` - *Type:* EcsEphemeralStorageUtilizedAlarmConfig The configuration for the EphemeralStorageUtilized alarm. --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: EcsCpuUtilizationAlarmConfig; ``` - *Type:* EcsCpuUtilizationAlarmConfig The configuration for the CpuUtilization alarm. --- ##### `configMemoryUtilizationAlarm`^Optional ```typescript public readonly configMemoryUtilizationAlarm: EcsMemoryUtilizationAlarmConfig; ``` - *Type:* EcsMemoryUtilizationAlarmConfig The configuration for the MemoryUtilization alarm. --- ##### `configRunningTaskCountAlarm`^Optional ```typescript public readonly configRunningTaskCountAlarm: EcsRunningTaskCountAlarmConfig; ``` - *Type:* EcsRunningTaskCountAlarmConfig The configuration for the RunningTaskCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: EcsRecommendedAlarmsMetrics[]; ``` - *Type:* EcsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `service`^Required ```typescript public readonly service: FargateService; ``` - *Type:* aws-cdk-lib.aws_ecs.FargateService The ECS service to monitor. --- ### EcsServiceRunningTaskCountAlarmProps The properties for the EcsServiceRunningTaskCountAlarm construct. #### Initializer ```typescript import { EcsServiceRunningTaskCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const ecsServiceRunningTaskCountAlarmProps: EcsServiceRunningTaskCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | service | aws-cdk-lib.aws_ecs.FargateService | The ECS service to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `service`^Required ```typescript public readonly service: FargateService; ``` - *Type:* aws-cdk-lib.aws_ecs.FargateService The ECS service to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect whether the number of running tasks are too low. A consistent low running task count can indicate ECS service deployment or performance issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* clusterName + ' - ' + serviceName + ' - RunningTaskCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You can adjust the threshold based on the minimum running task count of the ECS service. If the running task count is 0, the Amazon ECS service will be unavailable. --- ### EfsAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { EfsAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const efsAlarmBaseConfig: EfsAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### EfsBurstCreditBalanceAlarmConfig Configuration for the BurstCreditBalance alarm. #### Initializer ```typescript import { EfsBurstCreditBalanceAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const efsBurstCreditBalanceAlarmConfig: EfsBurstCreditBalanceAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | When the file system run out of burst credits and even if the baseline throughput rate is lower, EFS continues to provide a metered throughput of 1 MiBps to all file systems. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect low burst credit balance of the file system. Consistent low burst credit balance can be an indicator of the slowing down in throughput and increase in I/O latency. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* fileSystemId + ' - BurstCreditBalance' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 When the file system run out of burst credits and even if the baseline throughput rate is lower, EFS continues to provide a metered throughput of 1 MiBps to all file systems. However, it is recommended that the metric is monitored for low burst credit balance to avoid the file system acting as resource bottleneck for the applications. The threshold can be set around 0 bytes. --- ### EfsFileSystemAlarmProps The common properties for the EFS FileSystem alarms. #### Initializer ```typescript import { EfsFileSystemAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const efsFileSystemAlarmProps: EfsFileSystemAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fileSystem | aws-cdk-lib.aws_efs.FileSystem | The EFS FileSystem to monitor. | --- ##### `fileSystem`^Required ```typescript public readonly fileSystem: FileSystem; ``` - *Type:* aws-cdk-lib.aws_efs.FileSystem The EFS FileSystem to monitor. --- ### EfsFileSystemBurstCreditBalanceAlarmProps The properties for the EfsFileSystemBurstCreditBalanceAlarm construct. #### Initializer ```typescript import { EfsFileSystemBurstCreditBalanceAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const efsFileSystemBurstCreditBalanceAlarmProps: EfsFileSystemBurstCreditBalanceAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fileSystem | aws-cdk-lib.aws_efs.FileSystem | The EFS FileSystem to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | When the file system run out of burst credits and even if the baseline throughput rate is lower, EFS continues to provide a metered throughput of 1 MiBps to all file systems. | --- ##### `fileSystem`^Required ```typescript public readonly fileSystem: FileSystem; ``` - *Type:* aws-cdk-lib.aws_efs.FileSystem The EFS FileSystem to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect low burst credit balance of the file system. Consistent low burst credit balance can be an indicator of the slowing down in throughput and increase in I/O latency. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* fileSystemId + ' - BurstCreditBalance' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 When the file system run out of burst credits and even if the baseline throughput rate is lower, EFS continues to provide a metered throughput of 1 MiBps to all file systems. However, it is recommended that the metric is monitored for low burst credit balance to avoid the file system acting as resource bottleneck for the applications. The threshold can be set around 0 bytes. --- ### EfsFileSystemPercentIOLimitAlarmProps The properties for the EfsFileSystemPercentIOLimitAlarm construct. #### Initializer ```typescript import { EfsFileSystemPercentIOLimitAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const efsFileSystemPercentIOLimitAlarmProps: EfsFileSystemPercentIOLimitAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | fileSystem | aws-cdk-lib.aws_efs.FileSystem | The EFS FileSystem to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | When the file system reaches its I/O limit, it may respond to read and write requests slower. | --- ##### `fileSystem`^Required ```typescript public readonly fileSystem: FileSystem; ``` - *Type:* aws-cdk-lib.aws_efs.FileSystem The EFS FileSystem to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect how close the file system is to reach the I/O limit of the General Purpose performance mode. Consistent high I/O percentage can be an indicator of the file system cannot scale with respect to I/O requests enough and the file system can be a resource bottleneck for the applications that use the file system. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* fileSystemId + ' - PercentIOLimit' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 100 When the file system reaches its I/O limit, it may respond to read and write requests slower. Therefore, it is recommended that the metric is monitored to avoid impacting applications that use the file system. The threshold can be set around 100%. However, this value can be adjusted to a lower value based on file system characteristics. --- ### EfsFileSystemRecommendedAlarmsConfig Configurations for the recommended alarms for an EFS Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { EfsFileSystemRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const efsFileSystemRecommendedAlarmsConfig: EfsFileSystemRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configBurstCreditBalanceAlarm | EfsBurstCreditBalanceAlarmConfig | The configuration for the BurstCreditBalance alarm. | | configPercentIOLimitAlarm | EfsPercentIOLimitAlarmConfig | The configuration for the PercentIOLimit alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | EfsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configBurstCreditBalanceAlarm`^Optional ```typescript public readonly configBurstCreditBalanceAlarm: EfsBurstCreditBalanceAlarmConfig; ``` - *Type:* EfsBurstCreditBalanceAlarmConfig The configuration for the BurstCreditBalance alarm. --- ##### `configPercentIOLimitAlarm`^Optional ```typescript public readonly configPercentIOLimitAlarm: EfsPercentIOLimitAlarmConfig; ``` - *Type:* EfsPercentIOLimitAlarmConfig The configuration for the PercentIOLimit alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: EfsRecommendedAlarmsMetrics[]; ``` - *Type:* EfsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### EfsFileSystemRecommendedAlarmsProps Properties for the EfsFileSystemRecommendedAlarms construct. #### Initializer ```typescript import { EfsFileSystemRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const efsFileSystemRecommendedAlarmsProps: EfsFileSystemRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configBurstCreditBalanceAlarm | EfsBurstCreditBalanceAlarmConfig | The configuration for the BurstCreditBalance alarm. | | configPercentIOLimitAlarm | EfsPercentIOLimitAlarmConfig | The configuration for the PercentIOLimit alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | EfsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | fileSystem | aws-cdk-lib.aws_efs.FileSystem | The EFS FileSystem to monitor. | --- ##### `configBurstCreditBalanceAlarm`^Optional ```typescript public readonly configBurstCreditBalanceAlarm: EfsBurstCreditBalanceAlarmConfig; ``` - *Type:* EfsBurstCreditBalanceAlarmConfig The configuration for the BurstCreditBalance alarm. --- ##### `configPercentIOLimitAlarm`^Optional ```typescript public readonly configPercentIOLimitAlarm: EfsPercentIOLimitAlarmConfig; ``` - *Type:* EfsPercentIOLimitAlarmConfig The configuration for the PercentIOLimit alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: EfsRecommendedAlarmsMetrics[]; ``` - *Type:* EfsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `fileSystem`^Required ```typescript public readonly fileSystem: FileSystem; ``` - *Type:* aws-cdk-lib.aws_efs.FileSystem The EFS FileSystem to monitor. --- ### EfsPercentIOLimitAlarmConfig Configuration for the PercentIOLimit alarm. #### Initializer ```typescript import { EfsPercentIOLimitAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const efsPercentIOLimitAlarmConfig: EfsPercentIOLimitAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | When the file system reaches its I/O limit, it may respond to read and write requests slower. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect how close the file system is to reach the I/O limit of the General Purpose performance mode. Consistent high I/O percentage can be an indicator of the file system cannot scale with respect to I/O requests enough and the file system can be a resource bottleneck for the applications that use the file system. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* fileSystemId + ' - PercentIOLimit' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 100 When the file system reaches its I/O limit, it may respond to read and write requests slower. Therefore, it is recommended that the metric is monitored to avoid impacting applications that use the file system. The threshold can be set around 100%. However, this value can be adjusted to a lower value based on file system characteristics. --- ### ElastiCacheAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { ElastiCacheAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheAlarmBaseConfig: ElastiCacheAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### ElastiCacheClusterAlarmProps The common properties for the ElastiCache CfnCacheCluster alarms. #### Initializer ```typescript import { ElastiCacheClusterAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheClusterAlarmProps: ElastiCacheClusterAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheCluster | aws-cdk-lib.aws_elasticache.CfnCacheCluster | The ElastiCache CfnCacheCluster to monitor. | --- ##### `cacheCluster`^Required ```typescript public readonly cacheCluster: CfnCacheCluster; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnCacheCluster The ElastiCache CfnCacheCluster to monitor. --- ### ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps The properties for the ElastiCacheClusterDatabaseMemoryUsagePercentageAlarm construct. #### Initializer ```typescript import { ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps: ElastiCacheClusterDatabaseMemoryUsagePercentageAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheCluster | aws-cdk-lib.aws_elasticache.CfnCacheCluster | The ElastiCache CfnCacheCluster to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Depending on your application's memory requirements and the memory capacity of your ElastiCache cluster, you should set the threshold to the percentage that reflects the critical level of memory usage of the cluster. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `cacheCluster`^Required ```typescript public readonly cacheCluster: CfnCacheCluster; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnCacheCluster The ElastiCache CfnCacheCluster to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Depending on your application's memory requirements and the memory capacity of your ElastiCache cluster, you should set the threshold to the percentage that reflects the critical level of memory usage of the cluster. You can use historical memory usage data as reference for acceptable memory usage threshold. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high memory utilization of your cluster so that you can avoid failures when writing to your cluster. It is useful to know when you will need to scale up your cluster if your application does not expect to experience evictions. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* logicalId + ' - DatabaseMemoryUsagePercentage' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### ElastiCacheClusterEngineCpuUtilizationAlarmProps The properties for the ElastiCacheClusterEngineCpuUtilizationAlarm construct. #### Initializer ```typescript import { ElastiCacheClusterEngineCpuUtilizationAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheClusterEngineCpuUtilizationAlarmProps: ElastiCacheClusterEngineCpuUtilizationAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheCluster | aws-cdk-lib.aws_elasticache.CfnCacheCluster | The ElastiCache CfnCacheCluster to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | Set the threshold to a percentage that reflects the critical engine CPU utilization level for your application. | --- ##### `cacheCluster`^Required ```typescript public readonly cacheCluster: CfnCacheCluster; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnCacheCluster The ElastiCache CfnCacheCluster to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high CPU utilization of the Redis OSS engine thread. It is useful if you want to monitor the CPU usage of the database engine itself. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* logicalId + ' - EngineCPUUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 Set the threshold to a percentage that reflects the critical engine CPU utilization level for your application. You can benchmark your cluster using your application and expected workload to correlate EngineCPUUtilization and performance as a reference, and then set the threshold accordingly. In most cases, you can set the threshold to about 90% of your available CPU. --- ### ElastiCacheClusterRecommendedAlarmsConfig Configurations for the recommended alarms for an ElastiCache Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { ElastiCacheClusterRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheClusterRecommendedAlarmsConfig: ElastiCacheClusterRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configDatabaseMemoryUsagePercentageAlarm | ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig | The configuration for the DatabaseMemoryUsagePercentage alarm. | | configReplicationLagAlarm | ElastiCacheReplicationLagAlarmConfig | The configuration for the ReplicationLag alarm. | | configEngineCpuUtilizationAlarm | ElastiCacheEngineCpuUtilizationAlarmConfig | The configuration for the EngineCpuUtilization alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ElastiCacheRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configDatabaseMemoryUsagePercentageAlarm`^Required ```typescript public readonly configDatabaseMemoryUsagePercentageAlarm: ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig; ``` - *Type:* ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig The configuration for the DatabaseMemoryUsagePercentage alarm. --- ##### `configReplicationLagAlarm`^Required ```typescript public readonly configReplicationLagAlarm: ElastiCacheReplicationLagAlarmConfig; ``` - *Type:* ElastiCacheReplicationLagAlarmConfig The configuration for the ReplicationLag alarm. --- ##### `configEngineCpuUtilizationAlarm`^Optional ```typescript public readonly configEngineCpuUtilizationAlarm: ElastiCacheEngineCpuUtilizationAlarmConfig; ``` - *Type:* ElastiCacheEngineCpuUtilizationAlarmConfig The configuration for the EngineCpuUtilization alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ElastiCacheRecommendedAlarmsMetrics[]; ``` - *Type:* ElastiCacheRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### ElastiCacheClusterRecommendedAlarmsProps Properties for the ElastiCacheClusterRecommendedAlarms construct. #### Initializer ```typescript import { ElastiCacheClusterRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheClusterRecommendedAlarmsProps: ElastiCacheClusterRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configDatabaseMemoryUsagePercentageAlarm | ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig | The configuration for the DatabaseMemoryUsagePercentage alarm. | | configReplicationLagAlarm | ElastiCacheReplicationLagAlarmConfig | The configuration for the ReplicationLag alarm. | | configEngineCpuUtilizationAlarm | ElastiCacheEngineCpuUtilizationAlarmConfig | The configuration for the EngineCpuUtilization alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ElastiCacheRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | cacheCluster | aws-cdk-lib.aws_elasticache.CfnCacheCluster | The ElastiCache CfnCacheCluster to monitor. | --- ##### `configDatabaseMemoryUsagePercentageAlarm`^Required ```typescript public readonly configDatabaseMemoryUsagePercentageAlarm: ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig; ``` - *Type:* ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig The configuration for the DatabaseMemoryUsagePercentage alarm. --- ##### `configReplicationLagAlarm`^Required ```typescript public readonly configReplicationLagAlarm: ElastiCacheReplicationLagAlarmConfig; ``` - *Type:* ElastiCacheReplicationLagAlarmConfig The configuration for the ReplicationLag alarm. --- ##### `configEngineCpuUtilizationAlarm`^Optional ```typescript public readonly configEngineCpuUtilizationAlarm: ElastiCacheEngineCpuUtilizationAlarmConfig; ``` - *Type:* ElastiCacheEngineCpuUtilizationAlarmConfig The configuration for the EngineCpuUtilization alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ElastiCacheRecommendedAlarmsMetrics[]; ``` - *Type:* ElastiCacheRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `cacheCluster`^Required ```typescript public readonly cacheCluster: CfnCacheCluster; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnCacheCluster The ElastiCache CfnCacheCluster to monitor. --- ### ElastiCacheClusterReplicationLagAlarmProps The properties for the ElastiCacheClusterReplicationLagAlarm construct. #### Initializer ```typescript import { ElastiCacheClusterReplicationLagAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheClusterReplicationLagAlarmProps: ElastiCacheClusterReplicationLagAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheCluster | aws-cdk-lib.aws_elasticache.CfnCacheCluster | The ElastiCache CfnCacheCluster to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to your application's requirements and the potential impact of replication lag. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `cacheCluster`^Required ```typescript public readonly cacheCluster: CfnCacheCluster; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnCacheCluster The ElastiCache CfnCacheCluster to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to your application's requirements and the potential impact of replication lag. You should consider your application's expected write rates and network conditions for the acceptable replication lag. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect a delay between data updates on the primary node and their synchronization to replica node. It helps to ensure data consistency of a read replica cluster node. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* logicalId + ' - ReplicationLag' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig Configuration for the DatabaseMemoryUsagePercentage alarm. #### Initializer ```typescript import { ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheDatabaseMemoryUsagePercentageAlarmConfig: ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Depending on your application's memory requirements and the memory capacity of your ElastiCache cluster, you should set the threshold to the percentage that reflects the critical level of memory usage of the cluster. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Depending on your application's memory requirements and the memory capacity of your ElastiCache cluster, you should set the threshold to the percentage that reflects the critical level of memory usage of the cluster. You can use historical memory usage data as reference for acceptable memory usage threshold. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high memory utilization of your cluster so that you can avoid failures when writing to your cluster. It is useful to know when you will need to scale up your cluster if your application does not expect to experience evictions. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* logicalId + ' - DatabaseMemoryUsagePercentage' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### ElastiCacheEngineCpuUtilizationAlarmConfig Configuration for the EngineCpuUtilization alarm. #### Initializer ```typescript import { ElastiCacheEngineCpuUtilizationAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheEngineCpuUtilizationAlarmConfig: ElastiCacheEngineCpuUtilizationAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | Set the threshold to a percentage that reflects the critical engine CPU utilization level for your application. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high CPU utilization of the Redis OSS engine thread. It is useful if you want to monitor the CPU usage of the database engine itself. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* logicalId + ' - EngineCPUUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 Set the threshold to a percentage that reflects the critical engine CPU utilization level for your application. You can benchmark your cluster using your application and expected workload to correlate EngineCPUUtilization and performance as a reference, and then set the threshold accordingly. In most cases, you can set the threshold to about 90% of your available CPU. --- ### ElastiCacheReplicationGroupAlarmProps The common properties for the ElastiCache CfnReplicationGroup alarms. #### Initializer ```typescript import { ElastiCacheReplicationGroupAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheReplicationGroupAlarmProps: ElastiCacheReplicationGroupAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheReplicationGroup | aws-cdk-lib.aws_elasticache.CfnReplicationGroup | The ElastiCache CfnReplicationGroup to monitor. | --- ##### `cacheReplicationGroup`^Required ```typescript public readonly cacheReplicationGroup: CfnReplicationGroup; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnReplicationGroup The ElastiCache CfnReplicationGroup to monitor. --- ### ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps The properties for the ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarm construct. #### Initializer ```typescript import { ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps: ElastiCacheReplicationGroupDatabaseMemoryUsagePercentageAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheReplicationGroup | aws-cdk-lib.aws_elasticache.CfnReplicationGroup | The ElastiCache CfnReplicationGroup to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Depending on your application's memory requirements and the memory capacity of your ElastiCache cluster, you should set the threshold to the percentage that reflects the critical level of memory usage of the cluster. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `cacheReplicationGroup`^Required ```typescript public readonly cacheReplicationGroup: CfnReplicationGroup; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnReplicationGroup The ElastiCache CfnReplicationGroup to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Depending on your application's memory requirements and the memory capacity of your ElastiCache cluster, you should set the threshold to the percentage that reflects the critical level of memory usage of the cluster. You can use historical memory usage data as reference for acceptable memory usage threshold. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high memory utilization of your cluster so that you can avoid failures when writing to your cluster. It is useful to know when you will need to scale up your cluster if your application does not expect to experience evictions. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* logicalId + ' - DatabaseMemoryUsagePercentage' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps The properties for the ElastiCacheReplicationGroupEngineCpuUtilizationAlarm construct. #### Initializer ```typescript import { ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheReplicationGroupEngineCpuUtilizationAlarmProps: ElastiCacheReplicationGroupEngineCpuUtilizationAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheReplicationGroup | aws-cdk-lib.aws_elasticache.CfnReplicationGroup | The ElastiCache CfnReplicationGroup to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | Set the threshold to a percentage that reflects the critical engine CPU utilization level for your application. | --- ##### `cacheReplicationGroup`^Required ```typescript public readonly cacheReplicationGroup: CfnReplicationGroup; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnReplicationGroup The ElastiCache CfnReplicationGroup to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high CPU utilization of the Redis OSS engine thread. It is useful if you want to monitor the CPU usage of the database engine itself. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* logicalId + ' - EngineCPUUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 Set the threshold to a percentage that reflects the critical engine CPU utilization level for your application. You can benchmark your cluster using your application and expected workload to correlate EngineCPUUtilization and performance as a reference, and then set the threshold accordingly. In most cases, you can set the threshold to about 90% of your available CPU. --- ### ElastiCacheReplicationGroupRecommendedAlarmsConfig Configurations for the recommended alarms for an ElastiCache ReplicationGroup. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { ElastiCacheReplicationGroupRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheReplicationGroupRecommendedAlarmsConfig: ElastiCacheReplicationGroupRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configDatabaseMemoryUsagePercentageAlarm | ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig | The configuration for the DatabaseMemoryUsagePercentage alarm. | | configReplicationLagAlarm | ElastiCacheReplicationLagAlarmConfig | The configuration for the ReplicationLag alarm. | | configEngineCpuUtilizationAlarm | ElastiCacheEngineCpuUtilizationAlarmConfig | The configuration for the EngineCPUUtilization alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ElastiCacheRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configDatabaseMemoryUsagePercentageAlarm`^Required ```typescript public readonly configDatabaseMemoryUsagePercentageAlarm: ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig; ``` - *Type:* ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig The configuration for the DatabaseMemoryUsagePercentage alarm. --- ##### `configReplicationLagAlarm`^Required ```typescript public readonly configReplicationLagAlarm: ElastiCacheReplicationLagAlarmConfig; ``` - *Type:* ElastiCacheReplicationLagAlarmConfig The configuration for the ReplicationLag alarm. --- ##### `configEngineCpuUtilizationAlarm`^Optional ```typescript public readonly configEngineCpuUtilizationAlarm: ElastiCacheEngineCpuUtilizationAlarmConfig; ``` - *Type:* ElastiCacheEngineCpuUtilizationAlarmConfig The configuration for the EngineCPUUtilization alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ElastiCacheRecommendedAlarmsMetrics[]; ``` - *Type:* ElastiCacheRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### ElastiCacheReplicationGroupRecommendedAlarmsProps Properties for the ElastiCacheReplicationGroupRecommendedAlarms construct. #### Initializer ```typescript import { ElastiCacheReplicationGroupRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheReplicationGroupRecommendedAlarmsProps: ElastiCacheReplicationGroupRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configDatabaseMemoryUsagePercentageAlarm | ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig | The configuration for the DatabaseMemoryUsagePercentage alarm. | | configReplicationLagAlarm | ElastiCacheReplicationLagAlarmConfig | The configuration for the ReplicationLag alarm. | | configEngineCpuUtilizationAlarm | ElastiCacheEngineCpuUtilizationAlarmConfig | The configuration for the EngineCPUUtilization alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | ElastiCacheRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | cacheReplicationGroup | aws-cdk-lib.aws_elasticache.CfnReplicationGroup | The ElastiCache CfnReplicationGroup to monitor. | --- ##### `configDatabaseMemoryUsagePercentageAlarm`^Required ```typescript public readonly configDatabaseMemoryUsagePercentageAlarm: ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig; ``` - *Type:* ElastiCacheDatabaseMemoryUsagePercentageAlarmConfig The configuration for the DatabaseMemoryUsagePercentage alarm. --- ##### `configReplicationLagAlarm`^Required ```typescript public readonly configReplicationLagAlarm: ElastiCacheReplicationLagAlarmConfig; ``` - *Type:* ElastiCacheReplicationLagAlarmConfig The configuration for the ReplicationLag alarm. --- ##### `configEngineCpuUtilizationAlarm`^Optional ```typescript public readonly configEngineCpuUtilizationAlarm: ElastiCacheEngineCpuUtilizationAlarmConfig; ``` - *Type:* ElastiCacheEngineCpuUtilizationAlarmConfig The configuration for the EngineCPUUtilization alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: ElastiCacheRecommendedAlarmsMetrics[]; ``` - *Type:* ElastiCacheRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `cacheReplicationGroup`^Required ```typescript public readonly cacheReplicationGroup: CfnReplicationGroup; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnReplicationGroup The ElastiCache CfnReplicationGroup to monitor. --- ### ElastiCacheReplicationGroupReplicationLagAlarmProps The properties for the ElastiCacheReplicationGroupReplicationLagAlarm construct. #### Initializer ```typescript import { ElastiCacheReplicationGroupReplicationLagAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheReplicationGroupReplicationLagAlarmProps: ElastiCacheReplicationGroupReplicationLagAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheReplicationGroup | aws-cdk-lib.aws_elasticache.CfnReplicationGroup | The ElastiCache CfnReplicationGroup to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to your application's requirements and the potential impact of replication lag. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `cacheReplicationGroup`^Required ```typescript public readonly cacheReplicationGroup: CfnReplicationGroup; ``` - *Type:* aws-cdk-lib.aws_elasticache.CfnReplicationGroup The ElastiCache CfnReplicationGroup to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to your application's requirements and the potential impact of replication lag. You should consider your application's expected write rates and network conditions for the acceptable replication lag. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect a delay between data updates on the primary node and their synchronization to replica node. It helps to ensure data consistency of a read replica cluster node. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* logicalId + ' - ReplicationLag' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### ElastiCacheReplicationLagAlarmConfig Configuration for the ReplicationLag alarm. #### Initializer ```typescript import { ElastiCacheReplicationLagAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const elastiCacheReplicationLagAlarmConfig: ElastiCacheReplicationLagAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to your application's requirements and the potential impact of replication lag. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to your application's requirements and the potential impact of replication lag. You should consider your application's expected write rates and network conditions for the acceptable replication lag. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect a delay between data updates on the primary node and their synchronization to replica node. It helps to ensure data consistency of a read replica cluster node. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* logicalId + ' - ReplicationLag' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### LambdaAlarmBaseConfig #### Initializer ```typescript import { LambdaAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaAlarmBaseConfig: LambdaAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### LambdaConcurrentExecutionsAlarmConfig Configuration for the ConcurrentExecutions alarm. #### Initializer ```typescript import { LambdaConcurrentExecutionsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaConcurrentExecutionsAlarmConfig: LambdaConcurrentExecutionsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statictis is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor if the concurrency of the function is approaching the Region-level concurrency limit of your account. A function starts to be throttled if it reaches the concurrency limit. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* lambdaFunction.functionName + ' - ConcurrentExecutions' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 10 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 10 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 900 The value against which the specified statictis is compared. Set the threshold to about 90% of the concurrency quota set for the account in the Region. By default, your account has a concurrency quota of 1,000 across all functions in a Region. However, you can check the quota of your account, as it can be increased by contacting AWS support. --- ### LambdaConcurrentExecutionsAlarmProps The properties for the LambdaConcurrentExecutionsAlarm construct. #### Initializer ```typescript import { LambdaConcurrentExecutionsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaConcurrentExecutionsAlarmProps: LambdaConcurrentExecutionsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statictis is compared. | | lambdaFunction | aws-cdk-lib.aws_lambda.IFunction | The Lambda function to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor if the concurrency of the function is approaching the Region-level concurrency limit of your account. A function starts to be throttled if it reaches the concurrency limit. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* lambdaFunction.functionName + ' - ConcurrentExecutions' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 10 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 10 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 900 The value against which the specified statictis is compared. Set the threshold to about 90% of the concurrency quota set for the account in the Region. By default, your account has a concurrency quota of 1,000 across all functions in a Region. However, you can check the quota of your account, as it can be increased by contacting AWS support. --- ##### `lambdaFunction`^Required ```typescript public readonly lambdaFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction The Lambda function to monitor. --- ### LambdaDurationAlarmConfig Configuration for the Duration alarm. #### Initializer ```typescript import { LambdaDurationAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaDurationAlarmConfig: LambdaDurationAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statictis is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statictis is compared. The threshold for the duration depends on your application and workloads and your performance requirements. For high-performance requirements, set the threshold to a shorter time to see if the function is meeting expectations. You can also analyze historical data for duration metrics to see the if the time taken matches the performance expectation of the function, and then set the threshold to a longer time than the historical average. Make sure to set the threshold lower than the configured function timeout. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm detects long duration times for processing an event by a Lambda function. Long durations might be because of changes in function code making the function take longer to execute, or the function's dependencies taking longer. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* lambdaFunction.functionName + ' - Duration' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### LambdaDurationAlarmProps The properties for the LambdaDurationAlarm construct. #### Initializer ```typescript import { LambdaDurationAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaDurationAlarmProps: LambdaDurationAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statictis is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | lambdaFunction | aws-cdk-lib.aws_lambda.IFunction | The Lambda function to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statictis is compared. The threshold for the duration depends on your application and workloads and your performance requirements. For high-performance requirements, set the threshold to a shorter time to see if the function is meeting expectations. You can also analyze historical data for duration metrics to see the if the time taken matches the performance expectation of the function, and then set the threshold to a longer time than the historical average. Make sure to set the threshold lower than the configured function timeout. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm detects long duration times for processing an event by a Lambda function. Long durations might be because of changes in function code making the function take longer to execute, or the function's dependencies taking longer. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* lambdaFunction.functionName + ' - Duration' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `lambdaFunction`^Required ```typescript public readonly lambdaFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction The Lambda function to monitor. --- ### LambdaErrorsAlarmConfig Configuration for the Errors alarm. #### Initializer ```typescript import { LambdaErrorsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaErrorsAlarmConfig: LambdaErrorsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistics is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistics is compared. Set the threshold to a number greater than zero. The exact value can depend on the tolerance for errors in your application. Understand the criticality of the invocations that the function is handling. For some applications, any error might be unacceptable, while other applications might allow for a certain margin of error. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm detects high error counts. Errors includes the exceptions thrown by the code as well as exceptions thrown by the Lambda runtime. You can check the logs related to the function to diagnose the issue. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* lambdaFunction.functionName + ' - Errors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ### LambdaErrorsAlarmProps The properties for the LambdaErrorsAlarm construct. #### Initializer ```typescript import { LambdaErrorsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaErrorsAlarmProps: LambdaErrorsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistics is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | lambdaFunction | aws-cdk-lib.aws_lambda.IFunction | The Lambda function to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistics is compared. Set the threshold to a number greater than zero. The exact value can depend on the tolerance for errors in your application. Understand the criticality of the invocations that the function is handling. For some applications, any error might be unacceptable, while other applications might allow for a certain margin of error. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm detects high error counts. Errors includes the exceptions thrown by the code as well as exceptions thrown by the Lambda runtime. You can check the logs related to the function to diagnose the issue. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* lambdaFunction.functionName + ' - Errors' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `lambdaFunction`^Required ```typescript public readonly lambdaFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction The Lambda function to monitor. --- ### LambdaRecommendedAlarmsConfig Configuration for Lambda recommended alarms. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { LambdaRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaRecommendedAlarmsConfig: LambdaRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configDurationAlarm | LambdaDurationAlarmConfig | The configuration for the Duration alarm. | | configErrorsAlarm | LambdaErrorsAlarmConfig | The configuration for the Errors alarm. | | configThrottlesAlarm | LambdaThrottlesAlarmConfig | The configuration for the Throttles alarm. | | configConcurrentExecutionsAlarm | LambdaConcurrentExecutionsAlarmConfig | The configuration for the ConcurrentExecutions alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | LambdaRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configDurationAlarm`^Required ```typescript public readonly configDurationAlarm: LambdaDurationAlarmConfig; ``` - *Type:* LambdaDurationAlarmConfig The configuration for the Duration alarm. --- ##### `configErrorsAlarm`^Required ```typescript public readonly configErrorsAlarm: LambdaErrorsAlarmConfig; ``` - *Type:* LambdaErrorsAlarmConfig The configuration for the Errors alarm. --- ##### `configThrottlesAlarm`^Required ```typescript public readonly configThrottlesAlarm: LambdaThrottlesAlarmConfig; ``` - *Type:* LambdaThrottlesAlarmConfig The configuration for the Throttles alarm. --- ##### `configConcurrentExecutionsAlarm`^Optional ```typescript public readonly configConcurrentExecutionsAlarm: LambdaConcurrentExecutionsAlarmConfig; ``` - *Type:* LambdaConcurrentExecutionsAlarmConfig The configuration for the ConcurrentExecutions alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: LambdaRecommendedAlarmsMetrics[]; ``` - *Type:* LambdaRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### LambdaRecommendedAlarmsProps #### Initializer ```typescript import { LambdaRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaRecommendedAlarmsProps: LambdaRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configDurationAlarm | LambdaDurationAlarmConfig | The configuration for the Duration alarm. | | configErrorsAlarm | LambdaErrorsAlarmConfig | The configuration for the Errors alarm. | | configThrottlesAlarm | LambdaThrottlesAlarmConfig | The configuration for the Throttles alarm. | | configConcurrentExecutionsAlarm | LambdaConcurrentExecutionsAlarmConfig | The configuration for the ConcurrentExecutions alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | LambdaRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | lambdaFunction | aws-cdk-lib.aws_lambda.IFunction | The lambda function to apply the recommended alarms. | --- ##### `configDurationAlarm`^Required ```typescript public readonly configDurationAlarm: LambdaDurationAlarmConfig; ``` - *Type:* LambdaDurationAlarmConfig The configuration for the Duration alarm. --- ##### `configErrorsAlarm`^Required ```typescript public readonly configErrorsAlarm: LambdaErrorsAlarmConfig; ``` - *Type:* LambdaErrorsAlarmConfig The configuration for the Errors alarm. --- ##### `configThrottlesAlarm`^Required ```typescript public readonly configThrottlesAlarm: LambdaThrottlesAlarmConfig; ``` - *Type:* LambdaThrottlesAlarmConfig The configuration for the Throttles alarm. --- ##### `configConcurrentExecutionsAlarm`^Optional ```typescript public readonly configConcurrentExecutionsAlarm: LambdaConcurrentExecutionsAlarmConfig; ``` - *Type:* LambdaConcurrentExecutionsAlarmConfig The configuration for the ConcurrentExecutions alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: LambdaRecommendedAlarmsMetrics[]; ``` - *Type:* LambdaRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `lambdaFunction`^Required ```typescript public readonly lambdaFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction The lambda function to apply the recommended alarms. --- ### LambdaThrottlesAlarmConfig Configuration for the Throttles alarm. #### Initializer ```typescript import { LambdaThrottlesAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaThrottlesAlarmConfig: LambdaThrottlesAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statictis is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statictis is compared. Set the threshold to a number greater than zero. The exact value of the threshold can depend on the tolerance of the application. Set the threshold according to its usage and scaling requirements of the function. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm detects a high number of throttled invocation requests. Throttling occurs when there is no concurrency is available for scale up. There are several approaches to resolve this issue. 1) Request a concurrency increase from AWS Support in this Region. 2) Identify performance issues in the function to improve the speed of processing and therefore improve throughput. 3) Increase the batch size of the function, so that more messages are processed by each function invocation. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* lambdaFunction.functionName + ' - Throttles' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### LambdaThrottlesAlarmProps The properties for the LambdaThrottlesAlarm construct. #### Initializer ```typescript import { LambdaThrottlesAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const lambdaThrottlesAlarmProps: LambdaThrottlesAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statictis is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | lambdaFunction | aws-cdk-lib.aws_lambda.IFunction | The Lambda function to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statictis is compared. Set the threshold to a number greater than zero. The exact value of the threshold can depend on the tolerance of the application. Set the threshold according to its usage and scaling requirements of the function. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm detects a high number of throttled invocation requests. Throttling occurs when there is no concurrency is available for scale up. There are several approaches to resolve this issue. 1) Request a concurrency increase from AWS Support in this Region. 2) Identify performance issues in the function to improve the speed of processing and therefore improve throughput. 3) Increase the batch size of the function, so that more messages are processed by each function invocation. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* lambdaFunction.functionName + ' - Throttles' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `lambdaFunction`^Required ```typescript public readonly lambdaFunction: IFunction; ``` - *Type:* aws-cdk-lib.aws_lambda.IFunction The Lambda function to monitor. --- ### NetworkLoadBalancerAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { NetworkLoadBalancerAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkLoadBalancerAlarmBaseConfig: NetworkLoadBalancerAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### NetworkLoadBalancerAlarmProps The common properties for the NetworkLoadBalancer alarms. #### Initializer ```typescript import { NetworkLoadBalancerAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkLoadBalancerAlarmProps: NetworkLoadBalancerAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer | The NetworkLoadBalancer to monitor. | --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: NetworkLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer The NetworkLoadBalancer to monitor. --- ### NetworkLoadBalancerRecommendedAlarmsConfig Configurations for the recommended alarms for a NetworkLoadBalancer. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { NetworkLoadBalancerRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkLoadBalancerRecommendedAlarmsConfig: NetworkLoadBalancerRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configTcpElbResetCountAlarm | NetworkLoadBalancerTcpElbResetCountAlarmConfig | The configuration for the TcpElbResetCount alarm. | | configTcpTargetResetCountAlarm | NetworkLoadBalancerTcpTargetResetCountAlarmConfig | The configuration for the TcpTargetResetCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | NetworkLoadBalancerRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configTcpElbResetCountAlarm`^Optional ```typescript public readonly configTcpElbResetCountAlarm: NetworkLoadBalancerTcpElbResetCountAlarmConfig; ``` - *Type:* NetworkLoadBalancerTcpElbResetCountAlarmConfig The configuration for the TcpElbResetCount alarm. --- ##### `configTcpTargetResetCountAlarm`^Optional ```typescript public readonly configTcpTargetResetCountAlarm: NetworkLoadBalancerTcpTargetResetCountAlarmConfig; ``` - *Type:* NetworkLoadBalancerTcpTargetResetCountAlarmConfig The configuration for the TcpTargetResetCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: NetworkLoadBalancerRecommendedAlarmsMetrics[]; ``` - *Type:* NetworkLoadBalancerRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### NetworkLoadBalancerRecommendedAlarmsProps Properties for the NetworkLoadBalancerRecommendedAlarms construct. #### Initializer ```typescript import { NetworkLoadBalancerRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkLoadBalancerRecommendedAlarmsProps: NetworkLoadBalancerRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configTcpElbResetCountAlarm | NetworkLoadBalancerTcpElbResetCountAlarmConfig | The configuration for the TcpElbResetCount alarm. | | configTcpTargetResetCountAlarm | NetworkLoadBalancerTcpTargetResetCountAlarmConfig | The configuration for the TcpTargetResetCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | NetworkLoadBalancerRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer | The NetworkLoadBalancer to monitor. | --- ##### `configTcpElbResetCountAlarm`^Optional ```typescript public readonly configTcpElbResetCountAlarm: NetworkLoadBalancerTcpElbResetCountAlarmConfig; ``` - *Type:* NetworkLoadBalancerTcpElbResetCountAlarmConfig The configuration for the TcpElbResetCount alarm. --- ##### `configTcpTargetResetCountAlarm`^Optional ```typescript public readonly configTcpTargetResetCountAlarm: NetworkLoadBalancerTcpTargetResetCountAlarmConfig; ``` - *Type:* NetworkLoadBalancerTcpTargetResetCountAlarmConfig The configuration for the TcpTargetResetCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: NetworkLoadBalancerRecommendedAlarmsMetrics[]; ``` - *Type:* NetworkLoadBalancerRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: NetworkLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer The NetworkLoadBalancer to monitor. --- ### NetworkLoadBalancerTcpElbResetCountAlarmConfig Configuration for the TcpElbResetCount alarm. #### Initializer ```typescript import { NetworkLoadBalancerTcpElbResetCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkLoadBalancerTcpElbResetCountAlarmConfig: NetworkLoadBalancerTcpElbResetCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the load balancer is sending TCP reset packets. A high number of resets can indicate connectivity issues between the load balancer and clients. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - TcpElbResetCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the acceptable number of TCP resets from the load balancer. --- ### NetworkLoadBalancerTcpElbResetCountAlarmProps The properties for the NetworkLoadBalancerTcpElbResetCountAlarm construct. #### Initializer ```typescript import { NetworkLoadBalancerTcpElbResetCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkLoadBalancerTcpElbResetCountAlarmProps: NetworkLoadBalancerTcpElbResetCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer | The NetworkLoadBalancer to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: NetworkLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer The NetworkLoadBalancer to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the load balancer is sending TCP reset packets. A high number of resets can indicate connectivity issues between the load balancer and clients. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - TcpElbResetCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the acceptable number of TCP resets from the load balancer. --- ### NetworkLoadBalancerTcpTargetResetCountAlarmConfig Configuration for the TcpTargetResetCount alarm. #### Initializer ```typescript import { NetworkLoadBalancerTcpTargetResetCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkLoadBalancerTcpTargetResetCountAlarmConfig: NetworkLoadBalancerTcpTargetResetCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the targets are sending TCP reset packets. A high number of resets can indicate connectivity issues between the load balancer and targets. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - TcpTargetResetCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the acceptable number of TCP resets from targets. --- ### NetworkLoadBalancerTcpTargetResetCountAlarmProps The properties for the NetworkLoadBalancerTcpTargetResetCountAlarm construct. #### Initializer ```typescript import { NetworkLoadBalancerTcpTargetResetCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkLoadBalancerTcpTargetResetCountAlarmProps: NetworkLoadBalancerTcpTargetResetCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | loadBalancer | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer | The NetworkLoadBalancer to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `loadBalancer`^Required ```typescript public readonly loadBalancer: NetworkLoadBalancer; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkLoadBalancer The NetworkLoadBalancer to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the targets are sending TCP reset packets. A high number of resets can indicate connectivity issues between the load balancer and targets. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* loadBalancerName + ' - TcpTargetResetCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the acceptable number of TCP resets from targets. --- ### NetworkTargetGroupAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { NetworkTargetGroupAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkTargetGroupAlarmBaseConfig: NetworkTargetGroupAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### NetworkTargetGroupAlarmProps The common properties for the NetworkTargetGroup alarms. #### Initializer ```typescript import { NetworkTargetGroupAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkTargetGroupAlarmProps: NetworkTargetGroupAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | targetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup | The NetworkTargetGroup to monitor. | --- ##### `targetGroup`^Required ```typescript public readonly targetGroup: NetworkTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup The NetworkTargetGroup to monitor. --- ### NetworkTargetGroupHealthyHostCountAlarmConfig Configuration for the HealthyHostCount alarm. #### Initializer ```typescript import { NetworkTargetGroupHealthyHostCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkTargetGroupHealthyHostCountAlarmConfig: NetworkTargetGroupHealthyHostCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the number of healthy hosts in the target group falls below the threshold. A low number of healthy hosts can indicate service availability issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* targetGroupName + ' - HealthyHostCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 The value against which the specified statistic is compared. You should set this threshold based on the minimum number of healthy hosts required for your application to function properly. --- ### NetworkTargetGroupHealthyHostCountAlarmProps The properties for the NetworkTargetGroupHealthyHostCountAlarm construct. #### Initializer ```typescript import { NetworkTargetGroupHealthyHostCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkTargetGroupHealthyHostCountAlarmProps: NetworkTargetGroupHealthyHostCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | targetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup | The NetworkTargetGroup to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `targetGroup`^Required ```typescript public readonly targetGroup: NetworkTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup The NetworkTargetGroup to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the number of healthy hosts in the target group falls below the threshold. A low number of healthy hosts can indicate service availability issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* targetGroupName + ' - HealthyHostCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 The value against which the specified statistic is compared. You should set this threshold based on the minimum number of healthy hosts required for your application to function properly. --- ### NetworkTargetGroupRecommendedAlarmsConfig Configurations for the recommended alarms for a NetworkTargetGroup. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { NetworkTargetGroupRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkTargetGroupRecommendedAlarmsConfig: NetworkTargetGroupRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configHealthyHostCountAlarm | NetworkTargetGroupHealthyHostCountAlarmConfig | The configuration for the HealthyHostCount alarm. | | configUnHealthyHostCountAlarm | NetworkTargetGroupUnHealthyHostCountAlarmConfig | The configuration for the UnHealthyHostCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | NetworkTargetGroupRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configHealthyHostCountAlarm`^Optional ```typescript public readonly configHealthyHostCountAlarm: NetworkTargetGroupHealthyHostCountAlarmConfig; ``` - *Type:* NetworkTargetGroupHealthyHostCountAlarmConfig The configuration for the HealthyHostCount alarm. --- ##### `configUnHealthyHostCountAlarm`^Optional ```typescript public readonly configUnHealthyHostCountAlarm: NetworkTargetGroupUnHealthyHostCountAlarmConfig; ``` - *Type:* NetworkTargetGroupUnHealthyHostCountAlarmConfig The configuration for the UnHealthyHostCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: NetworkTargetGroupRecommendedAlarmsMetrics[]; ``` - *Type:* NetworkTargetGroupRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### NetworkTargetGroupRecommendedAlarmsProps Properties for the NetworkTargetGroupRecommendedAlarms construct. #### Initializer ```typescript import { NetworkTargetGroupRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkTargetGroupRecommendedAlarmsProps: NetworkTargetGroupRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configHealthyHostCountAlarm | NetworkTargetGroupHealthyHostCountAlarmConfig | The configuration for the HealthyHostCount alarm. | | configUnHealthyHostCountAlarm | NetworkTargetGroupUnHealthyHostCountAlarmConfig | The configuration for the UnHealthyHostCount alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | NetworkTargetGroupRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | targetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup | The NetworkTargetGroup to monitor. | --- ##### `configHealthyHostCountAlarm`^Optional ```typescript public readonly configHealthyHostCountAlarm: NetworkTargetGroupHealthyHostCountAlarmConfig; ``` - *Type:* NetworkTargetGroupHealthyHostCountAlarmConfig The configuration for the HealthyHostCount alarm. --- ##### `configUnHealthyHostCountAlarm`^Optional ```typescript public readonly configUnHealthyHostCountAlarm: NetworkTargetGroupUnHealthyHostCountAlarmConfig; ``` - *Type:* NetworkTargetGroupUnHealthyHostCountAlarmConfig The configuration for the UnHealthyHostCount alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: NetworkTargetGroupRecommendedAlarmsMetrics[]; ``` - *Type:* NetworkTargetGroupRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `targetGroup`^Required ```typescript public readonly targetGroup: NetworkTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup The NetworkTargetGroup to monitor. --- ### NetworkTargetGroupUnHealthyHostCountAlarmConfig Configuration for the UnHealthyHostCount alarm. #### Initializer ```typescript import { NetworkTargetGroupUnHealthyHostCountAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkTargetGroupUnHealthyHostCountAlarmConfig: NetworkTargetGroupUnHealthyHostCountAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the number of unhealthy hosts in the target group exceeds the threshold. A high number of unhealthy hosts can indicate service health issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* targetGroupName + ' - UnHealthyHostCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the maximum number of unhealthy hosts that your application can tolerate before service is impacted. --- ### NetworkTargetGroupUnHealthyHostCountAlarmProps The properties for the NetworkTargetGroupUnHealthyHostCountAlarm construct. #### Initializer ```typescript import { NetworkTargetGroupUnHealthyHostCountAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const networkTargetGroupUnHealthyHostCountAlarmProps: NetworkTargetGroupUnHealthyHostCountAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | targetGroup | aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup | The NetworkTargetGroup to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `targetGroup`^Required ```typescript public readonly targetGroup: NetworkTargetGroup; ``` - *Type:* aws-cdk-lib.aws_elasticloadbalancingv2.NetworkTargetGroup The NetworkTargetGroup to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect when the number of unhealthy hosts in the target group exceeds the threshold. A high number of unhealthy hosts can indicate service health issues. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* targetGroupName + ' - UnHealthyHostCount' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. You should set this threshold based on the maximum number of unhealthy hosts that your application can tolerate before service is impacted. --- ### PrivateLinkEndpointsAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { PrivateLinkEndpointsAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkEndpointsAlarmBaseConfig: PrivateLinkEndpointsAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### PrivateLinkEndpointsInterfaceVpcEndpointAlarmProps The common properties for the PrivateLink InterfaceVpcEndpoint alarms. #### Initializer ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkEndpointsInterfaceVpcEndpointAlarmProps: PrivateLinkEndpointsInterfaceVpcEndpointAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpoint | aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint | The PrivateLink InterfaceVpcEndpoint to monitor. | | endpointType | string | The type of the PrivateLink InterfaceVpcEndpoint. | | serviceName | string | The service name of the PrivateLink InterfaceVpcEndpoint. | | subnetId | string | The subnet ID of the PrivateLink InterfaceVpcEndpoint. | | vpcId | string | The VPC ID of the PrivateLink InterfaceVpcEndpoint. | --- ##### `endpoint`^Required ```typescript public readonly endpoint: InterfaceVpcEndpoint; ``` - *Type:* aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint The PrivateLink InterfaceVpcEndpoint to monitor. --- ##### `endpointType`^Required ```typescript public readonly endpointType: string; ``` - *Type:* string The type of the PrivateLink InterfaceVpcEndpoint. --- ##### `serviceName`^Required ```typescript public readonly serviceName: string; ``` - *Type:* string The service name of the PrivateLink InterfaceVpcEndpoint. --- ##### `subnetId`^Required ```typescript public readonly subnetId: string; ``` - *Type:* string The subnet ID of the PrivateLink InterfaceVpcEndpoint. --- ##### `vpcId`^Required ```typescript public readonly vpcId: string; ``` - *Type:* string The VPC ID of the PrivateLink InterfaceVpcEndpoint. --- ### PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps The properties for the PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarm construct. #### Initializer ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps: PrivateLinkEndpointsInterfaceVpcEndpointPacketsDroppedAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | endpoint | aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint | The PrivateLink InterfaceVpcEndpoint to monitor. | | endpointType | string | The type of the PrivateLink InterfaceVpcEndpoint. | | serviceName | string | The service name of the PrivateLink InterfaceVpcEndpoint. | | subnetId | string | The subnet ID of the PrivateLink InterfaceVpcEndpoint. | | vpcId | string | The VPC ID of the PrivateLink InterfaceVpcEndpoint. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | Set the threshold according to the use case. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | subnets | aws-cdk-lib.aws_ec2.ISubnet[] | The subnets of the PrivateLink InterfaceVpcEndpoint. | --- ##### `endpoint`^Required ```typescript public readonly endpoint: InterfaceVpcEndpoint; ``` - *Type:* aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint The PrivateLink InterfaceVpcEndpoint to monitor. --- ##### `endpointType`^Required ```typescript public readonly endpointType: string; ``` - *Type:* string The type of the PrivateLink InterfaceVpcEndpoint. --- ##### `serviceName`^Required ```typescript public readonly serviceName: string; ``` - *Type:* string The service name of the PrivateLink InterfaceVpcEndpoint. --- ##### `subnetId`^Required ```typescript public readonly subnetId: string; ``` - *Type:* string The subnet ID of the PrivateLink InterfaceVpcEndpoint. --- ##### `vpcId`^Required ```typescript public readonly vpcId: string; ``` - *Type:* string The VPC ID of the PrivateLink InterfaceVpcEndpoint. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the use case. If you want to be aware of the unhealthy status of the endpoint or endpoint service, you should set the threshold low so that you get a chance to fix the issue before a huge data loss. You can use historical data to understand the tolerance for dropped packets and set the threshold accordingly. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect if the endpoint or endpoint service is unhealthy. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* endpointId + ' - ' + subnetId + ' - PacketsDropped' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `subnets`^Optional ```typescript public readonly subnets: ISubnet[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISubnet[] The subnets of the PrivateLink InterfaceVpcEndpoint. --- ### PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig Configurations for the recommended alarms for an PrivateLink Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig: PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configPacketsDroppedAlarm | PrivateLinkEndpointsPacketsDroppedAlarmConfig | The configuration for the PacketsDropped alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | PrivateLinkEndpointsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configPacketsDroppedAlarm`^Required ```typescript public readonly configPacketsDroppedAlarm: PrivateLinkEndpointsPacketsDroppedAlarmConfig; ``` - *Type:* PrivateLinkEndpointsPacketsDroppedAlarmConfig The configuration for the PacketsDropped alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: PrivateLinkEndpointsRecommendedAlarmsMetrics[]; ``` - *Type:* PrivateLinkEndpointsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps Properties for the PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarms construct. #### Initializer ```typescript import { PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps: PrivateLinkEndpointsInterfaceVpcEndpointRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configPacketsDroppedAlarm | PrivateLinkEndpointsPacketsDroppedAlarmConfig | The configuration for the PacketsDropped alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | PrivateLinkEndpointsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | endpoint | aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint | The PrivateLink InterfaceVpcEndpoint to monitor. | --- ##### `configPacketsDroppedAlarm`^Required ```typescript public readonly configPacketsDroppedAlarm: PrivateLinkEndpointsPacketsDroppedAlarmConfig; ``` - *Type:* PrivateLinkEndpointsPacketsDroppedAlarmConfig The configuration for the PacketsDropped alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: PrivateLinkEndpointsRecommendedAlarmsMetrics[]; ``` - *Type:* PrivateLinkEndpointsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `endpoint`^Required ```typescript public readonly endpoint: InterfaceVpcEndpoint; ``` - *Type:* aws-cdk-lib.aws_ec2.InterfaceVpcEndpoint The PrivateLink InterfaceVpcEndpoint to monitor. --- ### PrivateLinkEndpointsPacketsDroppedAlarmConfig Configuration for the PacketsDropped alarm. #### Initializer ```typescript import { PrivateLinkEndpointsPacketsDroppedAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkEndpointsPacketsDroppedAlarmConfig: PrivateLinkEndpointsPacketsDroppedAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | endpointType | string | The type of the PrivateLink InterfaceVpcEndpoint. | | serviceName | string | The service name of the PrivateLink InterfaceVpcEndpoint. | | threshold | number | Set the threshold according to the use case. | | vpcId | string | The VPC ID of the PrivateLink InterfaceVpcEndpoint. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | subnets | aws-cdk-lib.aws_ec2.ISubnet[] | The subnets of the PrivateLink InterfaceVpcEndpoint. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `endpointType`^Required ```typescript public readonly endpointType: string; ``` - *Type:* string The type of the PrivateLink InterfaceVpcEndpoint. --- ##### `serviceName`^Required ```typescript public readonly serviceName: string; ``` - *Type:* string The service name of the PrivateLink InterfaceVpcEndpoint. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number Set the threshold according to the use case. If you want to be aware of the unhealthy status of the endpoint or endpoint service, you should set the threshold low so that you get a chance to fix the issue before a huge data loss. You can use historical data to understand the tolerance for dropped packets and set the threshold accordingly. --- ##### `vpcId`^Required ```typescript public readonly vpcId: string; ``` - *Type:* string The VPC ID of the PrivateLink InterfaceVpcEndpoint. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect if the endpoint or endpoint service is unhealthy. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* endpointId + ' - ' + subnetId + ' - PacketsDropped' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `subnets`^Optional ```typescript public readonly subnets: ISubnet[]; ``` - *Type:* aws-cdk-lib.aws_ec2.ISubnet[] The subnets of the PrivateLink InterfaceVpcEndpoint. --- ### PrivateLinkServicesAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { PrivateLinkServicesAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkServicesAlarmBaseConfig: PrivateLinkServicesAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### PrivateLinkServicesRstPacketsSentAlarmConfig Configuration for the RstPacketsSent alarm. #### Initializer ```typescript import { PrivateLinkServicesRstPacketsSentAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkServicesRstPacketsSentAlarmConfig: PrivateLinkServicesRstPacketsSentAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | loadBalancerArn | string | The load balancer ARN of the PrivateLink VpcEndpointService. | | threshold | number | The threshold depends on the use case. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | azs | string[] | The availability zone of the PrivateLink VpcEndpointService. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `loadBalancerArn`^Required ```typescript public readonly loadBalancerArn: string; ``` - *Type:* string The load balancer ARN of the PrivateLink VpcEndpointService. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The threshold depends on the use case. If your use case can tolerate targets being unhealthy, you can set the threshold high. If the use case can’t tolerate unhealthy targets you can set the threshold very low. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect unhealthy targets of an endpoint service. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* endpointServiceName + ' - ' + az + ' - RstPacketsSent' The alarm name. --- ##### `azs`^Optional ```typescript public readonly azs: string[]; ``` - *Type:* string[] The availability zone of the PrivateLink VpcEndpointService. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### PrivateLinkServicesVpcEndpointServiceAlarmProps The common properties for the PrivateLink VpcEndpointService alarms. #### Initializer ```typescript import { PrivateLinkServicesVpcEndpointServiceAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkServicesVpcEndpointServiceAlarmProps: PrivateLinkServicesVpcEndpointServiceAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | az | string | The availability zone of the PrivateLink VpcEndpointService. | | endpointService | aws-cdk-lib.aws_ec2.VpcEndpointService | The PrivateLink VpcEndpointService to monitor. | | loadBalancerArn | string | The load balancer ARN of the PrivateLink VpcEndpointService. | --- ##### `az`^Required ```typescript public readonly az: string; ``` - *Type:* string The availability zone of the PrivateLink VpcEndpointService. --- ##### `endpointService`^Required ```typescript public readonly endpointService: VpcEndpointService; ``` - *Type:* aws-cdk-lib.aws_ec2.VpcEndpointService The PrivateLink VpcEndpointService to monitor. --- ##### `loadBalancerArn`^Required ```typescript public readonly loadBalancerArn: string; ``` - *Type:* string The load balancer ARN of the PrivateLink VpcEndpointService. --- ### PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig Configurations for the recommended alarms for an PrivateLink Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig: PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configRstPacketsSentAlarm | PrivateLinkServicesRstPacketsSentAlarmConfig | The configuration for the RstPacketsSent alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | PrivateLinkServicesRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configRstPacketsSentAlarm`^Required ```typescript public readonly configRstPacketsSentAlarm: PrivateLinkServicesRstPacketsSentAlarmConfig; ``` - *Type:* PrivateLinkServicesRstPacketsSentAlarmConfig The configuration for the RstPacketsSent alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: PrivateLinkServicesRecommendedAlarmsMetrics[]; ``` - *Type:* PrivateLinkServicesRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps Properties for the PrivateLinkServicesVpcEndpointServiceRecommendedAlarms construct. #### Initializer ```typescript import { PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkServicesVpcEndpointServiceRecommendedAlarmsProps: PrivateLinkServicesVpcEndpointServiceRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configRstPacketsSentAlarm | PrivateLinkServicesRstPacketsSentAlarmConfig | The configuration for the RstPacketsSent alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | PrivateLinkServicesRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | endpointService | aws-cdk-lib.aws_ec2.VpcEndpointService | The PrivateLink VpcEndpointService to monitor. | --- ##### `configRstPacketsSentAlarm`^Required ```typescript public readonly configRstPacketsSentAlarm: PrivateLinkServicesRstPacketsSentAlarmConfig; ``` - *Type:* PrivateLinkServicesRstPacketsSentAlarmConfig The configuration for the RstPacketsSent alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: PrivateLinkServicesRecommendedAlarmsMetrics[]; ``` - *Type:* PrivateLinkServicesRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `endpointService`^Required ```typescript public readonly endpointService: VpcEndpointService; ``` - *Type:* aws-cdk-lib.aws_ec2.VpcEndpointService The PrivateLink VpcEndpointService to monitor. --- ### PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps The properties for the PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarm construct. #### Initializer ```typescript import { PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const privateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps: PrivateLinkServicesVpcEndpointServiceRstPacketsSentAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | az | string | The availability zone of the PrivateLink VpcEndpointService. | | endpointService | aws-cdk-lib.aws_ec2.VpcEndpointService | The PrivateLink VpcEndpointService to monitor. | | loadBalancerArn | string | The load balancer ARN of the PrivateLink VpcEndpointService. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The threshold depends on the use case. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | azs | string[] | The availability zone of the PrivateLink VpcEndpointService. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `az`^Required ```typescript public readonly az: string; ``` - *Type:* string The availability zone of the PrivateLink VpcEndpointService. --- ##### `endpointService`^Required ```typescript public readonly endpointService: VpcEndpointService; ``` - *Type:* aws-cdk-lib.aws_ec2.VpcEndpointService The PrivateLink VpcEndpointService to monitor. --- ##### `loadBalancerArn`^Required ```typescript public readonly loadBalancerArn: string; ``` - *Type:* string The load balancer ARN of the PrivateLink VpcEndpointService. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The threshold depends on the use case. If your use case can tolerate targets being unhealthy, you can set the threshold high. If the use case can’t tolerate unhealthy targets you can set the threshold very low. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect unhealthy targets of an endpoint service. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* endpointServiceName + ' - ' + az + ' - RstPacketsSent' The alarm name. --- ##### `azs`^Optional ```typescript public readonly azs: string[]; ``` - *Type:* string[] The availability zone of the PrivateLink VpcEndpointService. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { RdsAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsAlarmBaseConfig: RdsAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### RdsAuroraBinLogReplicationLagAlarmConfig Configuration for the AuroraBinLogReplicationLag alarm. #### Initializer ```typescript import { RdsAuroraBinLogReplicationLagAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsAuroraBinLogReplicationLagAlarmConfig: RdsAuroraBinLogReplicationLagAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect whether the writer instance is in an error state and can’t replicate the source. This alarm is recommended only for Aurora MySQL. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - AuroraBinLogReplicationLag' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 2 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 The value against which the specified statistic is compared. We recommend that you use -1 as the threshold value because Aurora MySQL publishes this value if the replica is in an error state. --- ### RdsAuroraBinLogReplicationLagAlarmProps The properties for the RdsAuroraBinLogReplicationLag construct. #### Initializer ```typescript import { RdsAuroraBinLogReplicationLagAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsAuroraBinLogReplicationLagAlarmProps: RdsAuroraBinLogReplicationLagAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value against which the specified statistic is compared. | | databaseCluster | aws-cdk-lib.aws_rds.IDatabaseCluster | The database cluster to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect whether the writer instance is in an error state and can’t replicate the source. This alarm is recommended only for Aurora MySQL. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - AuroraBinLogReplicationLag' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 2 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 2 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 The value against which the specified statistic is compared. We recommend that you use -1 as the threshold value because Aurora MySQL publishes this value if the replica is in an error state. --- ##### `databaseCluster`^Required ```typescript public readonly databaseCluster: IDatabaseCluster; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseCluster The database cluster to monitor. --- ### RdsAuroraRecommendedAlarmsConfig #### Initializer ```typescript import { RdsAuroraRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsAuroraRecommendedAlarmsConfig: RdsAuroraRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | RdsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | configDatabaseConnectionsAlarm | RdsDatabaseConnectionsAlarmConfig | The configuration for the DatabaseConnections alarm. | | configDbLoadAlarm | RdsDbLoadAlarmConfig | The configuration for the DbLoad alarm. | | configFreeableMemoryAlarm | RdsFreeableMemoryAlarmConfig | The configuration for the FreeableMemory alarm. | | configFreeLocalStorageAlarm | RdsFreeLocalStorageAlarmConfig | The configuration for the FreeLocalStorage alarm. | | configFreeStorageSpaceAlarm | RdsFreeStorageSpaceAlarmConfig | The configuration for the FreeStorageSpace alarm. | | configReadLatencyAlarm | RdsReadLatencyAlarmConfig | The configuration for the ReadLatency alarm. | | configWriteLatencyAlarm | RdsWriteLatencyAlarmConfig | The configuration for the WriteLatency alarm. | | configCpuUtilizationAlarm | RdsCpuUtilizationAlarmConfig | The configuration for the CpuUtilization alarm. | | configAuroraBinLogReplicationLagAlarm | RdsAuroraBinLogReplicationLagAlarmConfig | The configuration for the AuroraBinLogReplicationLag alarm. | | configAuroraVolumeBytesLeftTotalAlarm | RdsAuroraVolumeBytesLeftTotalAlarmConfig | The configuration for the AuroraVolumeBytesLeftTotal alarm. | | configAuroraVolumeBytesUsedAlarm | RdsAuroraVolumeBytesUsedAlarmConfig | The configuration for the VolumeBytesUsed anomaly detection alarm. | --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: RdsRecommendedAlarmsMetrics[]; ``` - *Type:* RdsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `configDatabaseConnectionsAlarm`^Required ```typescript public readonly configDatabaseConnectionsAlarm: RdsDatabaseConnectionsAlarmConfig; ``` - *Type:* RdsDatabaseConnectionsAlarmConfig The configuration for the DatabaseConnections alarm. --- ##### `configDbLoadAlarm`^Required ```typescript public readonly configDbLoadAlarm: RdsDbLoadAlarmConfig; ``` - *Type:* RdsDbLoadAlarmConfig The configuration for the DbLoad alarm. --- ##### `configFreeableMemoryAlarm`^Required ```typescript public readonly configFreeableMemoryAlarm: RdsFreeableMemoryAlarmConfig; ``` - *Type:* RdsFreeableMemoryAlarmConfig The configuration for the FreeableMemory alarm. --- ##### `configFreeLocalStorageAlarm`^Required ```typescript public readonly configFreeLocalStorageAlarm: RdsFreeLocalStorageAlarmConfig; ``` - *Type:* RdsFreeLocalStorageAlarmConfig The configuration for the FreeLocalStorage alarm. --- ##### `configFreeStorageSpaceAlarm`^Required ```typescript public readonly configFreeStorageSpaceAlarm: RdsFreeStorageSpaceAlarmConfig; ``` - *Type:* RdsFreeStorageSpaceAlarmConfig The configuration for the FreeStorageSpace alarm. --- ##### `configReadLatencyAlarm`^Required ```typescript public readonly configReadLatencyAlarm: RdsReadLatencyAlarmConfig; ``` - *Type:* RdsReadLatencyAlarmConfig The configuration for the ReadLatency alarm. --- ##### `configWriteLatencyAlarm`^Required ```typescript public readonly configWriteLatencyAlarm: RdsWriteLatencyAlarmConfig; ``` - *Type:* RdsWriteLatencyAlarmConfig The configuration for the WriteLatency alarm. --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: RdsCpuUtilizationAlarmConfig; ``` - *Type:* RdsCpuUtilizationAlarmConfig The configuration for the CpuUtilization alarm. --- ##### `configAuroraBinLogReplicationLagAlarm`^Optional ```typescript public readonly configAuroraBinLogReplicationLagAlarm: RdsAuroraBinLogReplicationLagAlarmConfig; ``` - *Type:* RdsAuroraBinLogReplicationLagAlarmConfig The configuration for the AuroraBinLogReplicationLag alarm. --- ##### `configAuroraVolumeBytesLeftTotalAlarm`^Optional ```typescript public readonly configAuroraVolumeBytesLeftTotalAlarm: RdsAuroraVolumeBytesLeftTotalAlarmConfig; ``` - *Type:* RdsAuroraVolumeBytesLeftTotalAlarmConfig The configuration for the AuroraVolumeBytesLeftTotal alarm. --- ##### `configAuroraVolumeBytesUsedAlarm`^Optional ```typescript public readonly configAuroraVolumeBytesUsedAlarm: RdsAuroraVolumeBytesUsedAlarmConfig; ``` - *Type:* RdsAuroraVolumeBytesUsedAlarmConfig The configuration for the VolumeBytesUsed anomaly detection alarm. --- ### RdsAuroraRecommendedAlarmsProps #### Initializer ```typescript import { RdsAuroraRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsAuroraRecommendedAlarmsProps: RdsAuroraRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | RdsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | configDatabaseConnectionsAlarm | RdsDatabaseConnectionsAlarmConfig | The configuration for the DatabaseConnections alarm. | | configDbLoadAlarm | RdsDbLoadAlarmConfig | The configuration for the DbLoad alarm. | | configFreeableMemoryAlarm | RdsFreeableMemoryAlarmConfig | The configuration for the FreeableMemory alarm. | | configFreeLocalStorageAlarm | RdsFreeLocalStorageAlarmConfig | The configuration for the FreeLocalStorage alarm. | | configFreeStorageSpaceAlarm | RdsFreeStorageSpaceAlarmConfig | The configuration for the FreeStorageSpace alarm. | | configReadLatencyAlarm | RdsReadLatencyAlarmConfig | The configuration for the ReadLatency alarm. | | configWriteLatencyAlarm | RdsWriteLatencyAlarmConfig | The configuration for the WriteLatency alarm. | | configCpuUtilizationAlarm | RdsCpuUtilizationAlarmConfig | The configuration for the CpuUtilization alarm. | | configAuroraBinLogReplicationLagAlarm | RdsAuroraBinLogReplicationLagAlarmConfig | The configuration for the AuroraBinLogReplicationLag alarm. | | configAuroraVolumeBytesLeftTotalAlarm | RdsAuroraVolumeBytesLeftTotalAlarmConfig | The configuration for the AuroraVolumeBytesLeftTotal alarm. | | configAuroraVolumeBytesUsedAlarm | RdsAuroraVolumeBytesUsedAlarmConfig | The configuration for the VolumeBytesUsed anomaly detection alarm. | | databaseCluster | aws-cdk-lib.aws_rds.IDatabaseCluster | The database cluster to apply the recommended alarms. | --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: RdsRecommendedAlarmsMetrics[]; ``` - *Type:* RdsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `configDatabaseConnectionsAlarm`^Required ```typescript public readonly configDatabaseConnectionsAlarm: RdsDatabaseConnectionsAlarmConfig; ``` - *Type:* RdsDatabaseConnectionsAlarmConfig The configuration for the DatabaseConnections alarm. --- ##### `configDbLoadAlarm`^Required ```typescript public readonly configDbLoadAlarm: RdsDbLoadAlarmConfig; ``` - *Type:* RdsDbLoadAlarmConfig The configuration for the DbLoad alarm. --- ##### `configFreeableMemoryAlarm`^Required ```typescript public readonly configFreeableMemoryAlarm: RdsFreeableMemoryAlarmConfig; ``` - *Type:* RdsFreeableMemoryAlarmConfig The configuration for the FreeableMemory alarm. --- ##### `configFreeLocalStorageAlarm`^Required ```typescript public readonly configFreeLocalStorageAlarm: RdsFreeLocalStorageAlarmConfig; ``` - *Type:* RdsFreeLocalStorageAlarmConfig The configuration for the FreeLocalStorage alarm. --- ##### `configFreeStorageSpaceAlarm`^Required ```typescript public readonly configFreeStorageSpaceAlarm: RdsFreeStorageSpaceAlarmConfig; ``` - *Type:* RdsFreeStorageSpaceAlarmConfig The configuration for the FreeStorageSpace alarm. --- ##### `configReadLatencyAlarm`^Required ```typescript public readonly configReadLatencyAlarm: RdsReadLatencyAlarmConfig; ``` - *Type:* RdsReadLatencyAlarmConfig The configuration for the ReadLatency alarm. --- ##### `configWriteLatencyAlarm`^Required ```typescript public readonly configWriteLatencyAlarm: RdsWriteLatencyAlarmConfig; ``` - *Type:* RdsWriteLatencyAlarmConfig The configuration for the WriteLatency alarm. --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: RdsCpuUtilizationAlarmConfig; ``` - *Type:* RdsCpuUtilizationAlarmConfig The configuration for the CpuUtilization alarm. --- ##### `configAuroraBinLogReplicationLagAlarm`^Optional ```typescript public readonly configAuroraBinLogReplicationLagAlarm: RdsAuroraBinLogReplicationLagAlarmConfig; ``` - *Type:* RdsAuroraBinLogReplicationLagAlarmConfig The configuration for the AuroraBinLogReplicationLag alarm. --- ##### `configAuroraVolumeBytesLeftTotalAlarm`^Optional ```typescript public readonly configAuroraVolumeBytesLeftTotalAlarm: RdsAuroraVolumeBytesLeftTotalAlarmConfig; ``` - *Type:* RdsAuroraVolumeBytesLeftTotalAlarmConfig The configuration for the AuroraVolumeBytesLeftTotal alarm. --- ##### `configAuroraVolumeBytesUsedAlarm`^Optional ```typescript public readonly configAuroraVolumeBytesUsedAlarm: RdsAuroraVolumeBytesUsedAlarmConfig; ``` - *Type:* RdsAuroraVolumeBytesUsedAlarmConfig The configuration for the VolumeBytesUsed anomaly detection alarm. --- ##### `databaseCluster`^Required ```typescript public readonly databaseCluster: IDatabaseCluster; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseCluster The database cluster to apply the recommended alarms. --- ### RdsAuroraVolumeBytesLeftTotalAlarmConfig Configuration for the AuroraVolumeBytesLeftTotal alarm. #### Initializer ```typescript import { RdsAuroraVolumeBytesLeftTotalAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsAuroraVolumeBytesLeftTotalAlarmConfig: RdsAuroraVolumeBytesLeftTotalAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value in bytes against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect how close the Aurora cluster is to the volume size limit. This alarm can prevent an out-of-space error that occurs when your cluster runs out of space. This alarm is recommended only for Aurora MySQL. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - AuroraVolumeBytesLeftTotal' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number The value in bytes against which the specified statistic is compared. You should calculate 10%-20% of the actual size limit based on velocity and trend of volume usage increase, and then use that result as the threshold value to proactively take action before the volume reaches its limit. --- ### RdsAuroraVolumeBytesLeftTotalAlarmProps The properties for the RdsAuroraVolumeBytesLeftTotal construct. #### Initializer ```typescript import { RdsAuroraVolumeBytesLeftTotalAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsAuroraVolumeBytesLeftTotalAlarmProps: RdsAuroraVolumeBytesLeftTotalAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The value in bytes against which the specified statistic is compared. | | databaseCluster | aws-cdk-lib.aws_rds.IDatabaseCluster | The database cluster to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect how close the Aurora cluster is to the volume size limit. This alarm can prevent an out-of-space error that occurs when your cluster runs out of space. This alarm is recommended only for Aurora MySQL. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - AuroraVolumeBytesLeftTotal' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number The value in bytes against which the specified statistic is compared. You should calculate 10%-20% of the actual size limit based on velocity and trend of volume usage increase, and then use that result as the threshold value to proactively take action before the volume reaches its limit. --- ##### `databaseCluster`^Required ```typescript public readonly databaseCluster: IDatabaseCluster; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseCluster The database cluster to monitor. --- ### RdsAuroraVolumeBytesUsedAlarmConfig Configuration for the VolumeBytesUsed anomaly detection alarm. #### Initializer ```typescript import { RdsAuroraVolumeBytesUsedAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsAuroraVolumeBytesUsedAlarmConfig: RdsAuroraVolumeBytesUsedAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator used to compare the metric against the anomaly detection band. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the anomaly detection band. | | stdDevs | number | The width of the anomaly detection band, expressed as a multiplier on the model's prediction interval. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm detects unusual growth in the amount of storage used by the Aurora cluster volume, which can indicate runaway storage usage (e.g. missing autovacuum, bloat, or a misbehaving ingest path) that would otherwise go unnoticed because Aurora storage grows automatically. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* cluster.clusterIdentifier + ' - VolumeBytesUsed' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* cloudwatch.ComparisonOperator.GREATER_THAN_UPPER_THRESHOLD The comparison operator used to compare the metric against the anomaly detection band. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the anomaly detection band. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a multiplier on the model's prediction interval. --- ### RdsAuroraVolumeBytesUsedAlarmProps The properties for the RdsAuroraVolumeBytesUsedAlarm construct. #### Initializer ```typescript import { RdsAuroraVolumeBytesUsedAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsAuroraVolumeBytesUsedAlarmProps: RdsAuroraVolumeBytesUsedAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | comparisonOperator | aws-cdk-lib.aws_cloudwatch.ComparisonOperator | The comparison operator used to compare the metric against the anomaly detection band. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the anomaly detection band. | | stdDevs | number | The width of the anomaly detection band, expressed as a multiplier on the model's prediction interval. | | databaseCluster | aws-cdk-lib.aws_rds.IDatabaseCluster | The database cluster to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm detects unusual growth in the amount of storage used by the Aurora cluster volume, which can indicate runaway storage usage (e.g. missing autovacuum, bloat, or a misbehaving ingest path) that would otherwise go unnoticed because Aurora storage grows automatically. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* cluster.clusterIdentifier + ' - VolumeBytesUsed' The alarm name. --- ##### `comparisonOperator`^Optional ```typescript public readonly comparisonOperator: ComparisonOperator; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.ComparisonOperator - *Default:* cloudwatch.ComparisonOperator.GREATER_THAN_UPPER_THRESHOLD The comparison operator used to compare the metric against the anomaly detection band. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the anomaly detection band. --- ##### `stdDevs`^Optional ```typescript public readonly stdDevs: number; ``` - *Type:* number - *Default:* 8 The width of the anomaly detection band, expressed as a multiplier on the model's prediction interval. --- ##### `databaseCluster`^Required ```typescript public readonly databaseCluster: IDatabaseCluster; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseCluster The database cluster to monitor. --- ### RdsCpuUtilizationAlarmConfig Configuration for the CpuUtilization alarm. #### Initializer ```typescript import { RdsCpuUtilizationAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsCpuUtilizationAlarmConfig: RdsCpuUtilizationAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The percentage (0-100) value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect consistent high CPU utilization in order to prevent very high response time and time-outs. If you want to check micro-bursting of CPU utilization you can set a lower alarm evaluation time. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - CpuUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 The percentage (0-100) value against which the specified statistic is compared. Random spikes in CPU consumption might not hamper database performance, but sustained high CPU can hinder upcoming database requests. Depending on the overall database workload, high CPU at your RDS/Aurora instance can degrade the overall performance. --- ### RdsDatabaseConnectionsAlarmConfig Configuration for the DatabaseConnections alarm. #### Initializer ```typescript import { RdsDatabaseConnectionsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsDatabaseConnectionsAlarmConfig: RdsDatabaseConnectionsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The number of connections against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The number of connections against which the specified statistic is compared. The number of connections allowed depends on the size of your DB instance class and database engine-specific parameters related to processes/connections. You should calculate a value between 90-95% of the maximum number of connections for your database and use that result as the threshold value. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to help prevent rejected connections when the maximum number of DB connections is reached. This alarm is not recommended if you frequently change DB instance class, because doing so changes the memory and default maximum number of connections. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - DatabaseConnections' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsDbLoadAlarmConfig Configuration for the DbLoad alarm. #### Initializer ```typescript import { RdsDbLoadAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsDbLoadAlarmConfig: RdsDbLoadAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The maximum vCPU value is determined by the number of vCPU (virtual CPU) cores for your DB instance. Depending on the maximum vCPU, different values for the threshold can be appropriate. Ideally, DB load should not go above vCPU line. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect a high DB load. High DB load can cause performance issues in the DB instance. This alarm is not applicable to serverless DB instances. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - DBLoad' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### RdsFreeableMemoryAlarmConfig Configuration for the FreeableMemory alarm. #### Initializer ```typescript import { RdsFreeableMemoryAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsFreeableMemoryAlarmConfig: RdsFreeableMemoryAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The percentage value (0-100) against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The percentage value (0-100) against which the specified statistic is compared. Depending on the workload and instance class, different values for the threshold can be appropriate. Ideally, available memory should not go below 25% of total memory for prolonged periods. For Aurora, you can set the threshold close to 5%, because the metric approaching 0 means that the DB instance has scaled up as much as it can. You can analyze the historical behavior of this metric to determine sensible threshold levels. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to help prevent running out of memory which can result in rejected connections. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - FreeableMemory' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### RdsFreeLocalStorageAlarmConfig Configuration for the FreeLocalStorage alarm. #### Initializer ```typescript import { RdsFreeLocalStorageAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsFreeLocalStorageAlarmConfig: RdsFreeLocalStorageAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The percentage value (0-100) against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The percentage value (0-100) against which the specified statistic is compared. You should calculate about 10%-20% of the amount of storage available based on velocity and trend of volume usage, and then use that result as the threshold value to proactively take action before the volume reaches its limit. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect how close the Aurora DB instance is to reaching the local storage limit, if you do not use Aurora Serverless v2 or higher. Local storage can reach capacity when you store non-persistent data, such as temporary table and log files, in the local storage. This alarm can prevent an out-of-space error that occurs when your DB instance runs out of local storage. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - FreeLocalStorage' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsFreeStorageSpaceAlarmConfig Configuration for the FreeStorageSpace alarm. #### Initializer ```typescript import { RdsFreeStorageSpaceAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsFreeStorageSpaceAlarmConfig: RdsFreeStorageSpaceAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The percentage value (0-100) against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The percentage value (0-100) against which the specified statistic is compared. The threshold value will depend on the currently allocated storage space. Typically, you should calculate the value of 10 percent of the allocated storage space and use that result as the threshold value. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps prevent storage full issues. This can prevent downtime that occurs when your database instance runs out of storage. We do not recommend using this alarm if you have storage auto scaling enabled, or if you frequently change the storage capacity of the database instance. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - FreeStorageSpace' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsInstanceAlarmProps The common properties for the instance alarms. The alarm should receive either instanceIdentifier or databaseInstance. #### Initializer ```typescript import { RdsInstanceAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceAlarmProps: RdsInstanceAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The database instance to monitor. | | instanceIdentifier | string | The database instance identifier to monitor. | --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The database instance to monitor. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The database instance identifier to monitor. --- ### RdsInstanceCpuUtilizationAlarmProps The properties for the RdsInstanceCpuUtilizationAlarm construct. #### Initializer ```typescript import { RdsInstanceCpuUtilizationAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceCpuUtilizationAlarmProps: RdsInstanceCpuUtilizationAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The database instance to monitor. | | instanceIdentifier | string | The database instance identifier to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The percentage (0-100) value against which the specified statistic is compared. | --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The database instance to monitor. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The database instance identifier to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect consistent high CPU utilization in order to prevent very high response time and time-outs. If you want to check micro-bursting of CPU utilization you can set a lower alarm evaluation time. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - CpuUtilization' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 90 The percentage (0-100) value against which the specified statistic is compared. Random spikes in CPU consumption might not hamper database performance, but sustained high CPU can hinder upcoming database requests. Depending on the overall database workload, high CPU at your RDS/Aurora instance can degrade the overall performance. --- ### RdsInstanceDatabaseConnectionsAlarmProps The properties for the RdsInstanceDatabaseConnectionsAlarm construct. #### Initializer ```typescript import { RdsInstanceDatabaseConnectionsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceDatabaseConnectionsAlarmProps: RdsInstanceDatabaseConnectionsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The database instance to monitor. | | instanceIdentifier | string | The database instance identifier to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The number of connections against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The database instance to monitor. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The database instance identifier to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The number of connections against which the specified statistic is compared. The number of connections allowed depends on the size of your DB instance class and database engine-specific parameters related to processes/connections. You should calculate a value between 90-95% of the maximum number of connections for your database and use that result as the threshold value. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to help prevent rejected connections when the maximum number of DB connections is reached. This alarm is not recommended if you frequently change DB instance class, because doing so changes the memory and default maximum number of connections. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - DatabaseConnections' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsInstanceDbLoadAlarmProps The properties for the RdsInstanceDbLoadAlarm construct. #### Initializer ```typescript import { RdsInstanceDbLoadAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceDbLoadAlarmProps: RdsInstanceDbLoadAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The database instance to monitor. | | instanceIdentifier | string | The database instance identifier to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The database instance to monitor. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The database instance identifier to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The maximum vCPU value is determined by the number of vCPU (virtual CPU) cores for your DB instance. Depending on the maximum vCPU, different values for the threshold can be appropriate. Ideally, DB load should not go above vCPU line. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect a high DB load. High DB load can cause performance issues in the DB instance. This alarm is not applicable to serverless DB instances. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - DBLoad' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### RdsInstanceFreeableMemoryAlarmProps The properties for the RdsInstanceFreeableMemoryAlarm construct. #### Initializer ```typescript import { RdsInstanceFreeableMemoryAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceFreeableMemoryAlarmProps: RdsInstanceFreeableMemoryAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The database instance to monitor. | | instanceIdentifier | string | The database instance identifier to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The percentage value (0-100) against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The database instance to monitor. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The database instance identifier to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The percentage value (0-100) against which the specified statistic is compared. Depending on the workload and instance class, different values for the threshold can be appropriate. Ideally, available memory should not go below 25% of total memory for prolonged periods. For Aurora, you can set the threshold close to 5%, because the metric approaching 0 means that the DB instance has scaled up as much as it can. You can analyze the historical behavior of this metric to determine sensible threshold levels. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to help prevent running out of memory which can result in rejected connections. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - FreeableMemory' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ### RdsInstanceFreeLocalStorageAlarmProps The properties for the RdsInstanceFreeLocalStorageAlarm construct. #### Initializer ```typescript import { RdsInstanceFreeLocalStorageAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceFreeLocalStorageAlarmProps: RdsInstanceFreeLocalStorageAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The database instance to monitor. | | instanceIdentifier | string | The database instance identifier to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The percentage value (0-100) against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The database instance to monitor. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The database instance identifier to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The percentage value (0-100) against which the specified statistic is compared. You should calculate about 10%-20% of the amount of storage available based on velocity and trend of volume usage, and then use that result as the threshold value to proactively take action before the volume reaches its limit. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect how close the Aurora DB instance is to reaching the local storage limit, if you do not use Aurora Serverless v2 or higher. Local storage can reach capacity when you store non-persistent data, such as temporary table and log files, in the local storage. This alarm can prevent an out-of-space error that occurs when your DB instance runs out of local storage. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - FreeLocalStorage' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsInstanceFreeStorageSpaceAlarmProps The properties for the RdsInstanceFreeStorageSpaceAlarm construct. #### Initializer ```typescript import { RdsInstanceFreeStorageSpaceAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceFreeStorageSpaceAlarmProps: RdsInstanceFreeStorageSpaceAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The database instance to monitor. | | instanceIdentifier | string | The database instance identifier to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The percentage value (0-100) against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The database instance to monitor. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The database instance identifier to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The percentage value (0-100) against which the specified statistic is compared. The threshold value will depend on the currently allocated storage space. Typically, you should calculate the value of 10 percent of the allocated storage space and use that result as the threshold value. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps prevent storage full issues. This can prevent downtime that occurs when your database instance runs out of storage. We do not recommend using this alarm if you have storage auto scaling enabled, or if you frequently change the storage capacity of the database instance. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - FreeStorageSpace' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsInstanceReadLatencyAlarmProps The properties for the RdsInstanceReadLatencyAlarm construct. #### Initializer ```typescript import { RdsInstanceReadLatencyAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceReadLatencyAlarmProps: RdsInstanceReadLatencyAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The database instance to monitor. | | instanceIdentifier | string | The database instance identifier to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value in milliseconds against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The database instance to monitor. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The database instance identifier to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value in milliseconds against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on your use case. Read latencies higher than 20 milliseconds are likely a cause for investigation. You can also set a higher threshold if your application can have higher latency for read operations. Review the criticality and requirements of read latency and analyze the historical behavior of this metric to determine sensible threshold levels. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high read latency. Database disks normally have a low read/write latency, but they can have issues that can cause high latency operations. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - ReadLatency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsInstanceRecommendedAlarmsConfig #### Initializer ```typescript import { RdsInstanceRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceRecommendedAlarmsConfig: RdsInstanceRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | RdsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | configDatabaseConnectionsAlarm | RdsDatabaseConnectionsAlarmConfig | The configuration for the DatabaseConnections alarm. | | configDbLoadAlarm | RdsDbLoadAlarmConfig | The configuration for the DbLoad alarm. | | configFreeableMemoryAlarm | RdsFreeableMemoryAlarmConfig | The configuration for the FreeableMemory alarm. | | configFreeLocalStorageAlarm | RdsFreeLocalStorageAlarmConfig | The configuration for the FreeLocalStorage alarm. | | configFreeStorageSpaceAlarm | RdsFreeStorageSpaceAlarmConfig | The configuration for the FreeStorageSpace alarm. | | configReadLatencyAlarm | RdsReadLatencyAlarmConfig | The configuration for the ReadLatency alarm. | | configWriteLatencyAlarm | RdsWriteLatencyAlarmConfig | The configuration for the WriteLatency alarm. | | configCpuUtilizationAlarm | RdsCpuUtilizationAlarmConfig | The configuration for the CpuUtilization alarm. | --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: RdsRecommendedAlarmsMetrics[]; ``` - *Type:* RdsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `configDatabaseConnectionsAlarm`^Required ```typescript public readonly configDatabaseConnectionsAlarm: RdsDatabaseConnectionsAlarmConfig; ``` - *Type:* RdsDatabaseConnectionsAlarmConfig The configuration for the DatabaseConnections alarm. --- ##### `configDbLoadAlarm`^Required ```typescript public readonly configDbLoadAlarm: RdsDbLoadAlarmConfig; ``` - *Type:* RdsDbLoadAlarmConfig The configuration for the DbLoad alarm. --- ##### `configFreeableMemoryAlarm`^Required ```typescript public readonly configFreeableMemoryAlarm: RdsFreeableMemoryAlarmConfig; ``` - *Type:* RdsFreeableMemoryAlarmConfig The configuration for the FreeableMemory alarm. --- ##### `configFreeLocalStorageAlarm`^Required ```typescript public readonly configFreeLocalStorageAlarm: RdsFreeLocalStorageAlarmConfig; ``` - *Type:* RdsFreeLocalStorageAlarmConfig The configuration for the FreeLocalStorage alarm. --- ##### `configFreeStorageSpaceAlarm`^Required ```typescript public readonly configFreeStorageSpaceAlarm: RdsFreeStorageSpaceAlarmConfig; ``` - *Type:* RdsFreeStorageSpaceAlarmConfig The configuration for the FreeStorageSpace alarm. --- ##### `configReadLatencyAlarm`^Required ```typescript public readonly configReadLatencyAlarm: RdsReadLatencyAlarmConfig; ``` - *Type:* RdsReadLatencyAlarmConfig The configuration for the ReadLatency alarm. --- ##### `configWriteLatencyAlarm`^Required ```typescript public readonly configWriteLatencyAlarm: RdsWriteLatencyAlarmConfig; ``` - *Type:* RdsWriteLatencyAlarmConfig The configuration for the WriteLatency alarm. --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: RdsCpuUtilizationAlarmConfig; ``` - *Type:* RdsCpuUtilizationAlarmConfig The configuration for the CpuUtilization alarm. --- ### RdsInstanceRecommendedAlarmsProps #### Initializer ```typescript import { RdsInstanceRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceRecommendedAlarmsProps: RdsInstanceRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | RdsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | configDatabaseConnectionsAlarm | RdsDatabaseConnectionsAlarmConfig | The configuration for the DatabaseConnections alarm. | | configDbLoadAlarm | RdsDbLoadAlarmConfig | The configuration for the DbLoad alarm. | | configFreeableMemoryAlarm | RdsFreeableMemoryAlarmConfig | The configuration for the FreeableMemory alarm. | | configFreeLocalStorageAlarm | RdsFreeLocalStorageAlarmConfig | The configuration for the FreeLocalStorage alarm. | | configFreeStorageSpaceAlarm | RdsFreeStorageSpaceAlarmConfig | The configuration for the FreeStorageSpace alarm. | | configReadLatencyAlarm | RdsReadLatencyAlarmConfig | The configuration for the ReadLatency alarm. | | configWriteLatencyAlarm | RdsWriteLatencyAlarmConfig | The configuration for the WriteLatency alarm. | | configCpuUtilizationAlarm | RdsCpuUtilizationAlarmConfig | The configuration for the CpuUtilization alarm. | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The cluster instance to apply the recommended alarms. | | instanceIdentifier | string | The cluster instance identifier to apply the recommended alarms. | --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: RdsRecommendedAlarmsMetrics[]; ``` - *Type:* RdsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `configDatabaseConnectionsAlarm`^Required ```typescript public readonly configDatabaseConnectionsAlarm: RdsDatabaseConnectionsAlarmConfig; ``` - *Type:* RdsDatabaseConnectionsAlarmConfig The configuration for the DatabaseConnections alarm. --- ##### `configDbLoadAlarm`^Required ```typescript public readonly configDbLoadAlarm: RdsDbLoadAlarmConfig; ``` - *Type:* RdsDbLoadAlarmConfig The configuration for the DbLoad alarm. --- ##### `configFreeableMemoryAlarm`^Required ```typescript public readonly configFreeableMemoryAlarm: RdsFreeableMemoryAlarmConfig; ``` - *Type:* RdsFreeableMemoryAlarmConfig The configuration for the FreeableMemory alarm. --- ##### `configFreeLocalStorageAlarm`^Required ```typescript public readonly configFreeLocalStorageAlarm: RdsFreeLocalStorageAlarmConfig; ``` - *Type:* RdsFreeLocalStorageAlarmConfig The configuration for the FreeLocalStorage alarm. --- ##### `configFreeStorageSpaceAlarm`^Required ```typescript public readonly configFreeStorageSpaceAlarm: RdsFreeStorageSpaceAlarmConfig; ``` - *Type:* RdsFreeStorageSpaceAlarmConfig The configuration for the FreeStorageSpace alarm. --- ##### `configReadLatencyAlarm`^Required ```typescript public readonly configReadLatencyAlarm: RdsReadLatencyAlarmConfig; ``` - *Type:* RdsReadLatencyAlarmConfig The configuration for the ReadLatency alarm. --- ##### `configWriteLatencyAlarm`^Required ```typescript public readonly configWriteLatencyAlarm: RdsWriteLatencyAlarmConfig; ``` - *Type:* RdsWriteLatencyAlarmConfig The configuration for the WriteLatency alarm. --- ##### `configCpuUtilizationAlarm`^Optional ```typescript public readonly configCpuUtilizationAlarm: RdsCpuUtilizationAlarmConfig; ``` - *Type:* RdsCpuUtilizationAlarmConfig The configuration for the CpuUtilization alarm. --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The cluster instance to apply the recommended alarms. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The cluster instance identifier to apply the recommended alarms. --- ### RdsInstanceWriteLatencyAlarmProps The properties for the RdsInstanceWriteLatencyAlarm construct. #### Initializer ```typescript import { RdsInstanceWriteLatencyAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsInstanceWriteLatencyAlarmProps: RdsInstanceWriteLatencyAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | databaseInstance | aws-cdk-lib.aws_rds.IDatabaseInstance | The database instance to monitor. | | instanceIdentifier | string | The database instance identifier to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value in milliseconds against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `databaseInstance`^Optional ```typescript public readonly databaseInstance: IDatabaseInstance; ``` - *Type:* aws-cdk-lib.aws_rds.IDatabaseInstance The database instance to monitor. --- ##### `instanceIdentifier`^Optional ```typescript public readonly instanceIdentifier: string; ``` - *Type:* string The database instance identifier to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value in milliseconds against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on your use case. Write latencies higher than 20 milliseconds are likely a cause for investigation. You can also set a higher threshold if your application can have a higher latency for write operations. Review the criticality and requirements of write latency and analyze the historical behavior of this metric to determine sensible threshold levels. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high write latency. Although database disks typically have low read/write latency, they may experience problems that cause high latency operations. Monitoring this will assure you the disk latency is as low as expected. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - WriteLatency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsReadLatencyAlarmConfig Configuration for the ReadLatency alarm. #### Initializer ```typescript import { RdsReadLatencyAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsReadLatencyAlarmConfig: RdsReadLatencyAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value in milliseconds against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value in milliseconds against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on your use case. Read latencies higher than 20 milliseconds are likely a cause for investigation. You can also set a higher threshold if your application can have higher latency for read operations. Review the criticality and requirements of read latency and analyze the historical behavior of this metric to determine sensible threshold levels. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high read latency. Database disks normally have a low read/write latency, but they can have issues that can cause high latency operations. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - ReadLatency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### RdsRecommendedAlarmsConfig Configuration for RDS recommended alarms. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { RdsRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsRecommendedAlarmsConfig: RdsRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | RdsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: RdsRecommendedAlarmsMetrics[]; ``` - *Type:* RdsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### RdsWriteLatencyAlarmConfig Configuration for the WriteLatency alarm. #### Initializer ```typescript import { RdsWriteLatencyAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const rdsWriteLatencyAlarmConfig: RdsWriteLatencyAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value in milliseconds against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value in milliseconds against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on your use case. Write latencies higher than 20 milliseconds are likely a cause for investigation. You can also set a higher threshold if your application can have a higher latency for write operations. Review the criticality and requirements of write latency and analyze the historical behavior of this metric to determine sensible threshold levels. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect high write latency. Although database disks typically have low read/write latency, they may experience problems that cause high latency operations. Monitoring this will assure you the disk latency is as low as expected. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* database.instanceIdentifiers[*] + ' - WriteLatency' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### ReplicationTaskProps #### Initializer ```typescript import { ReplicationTaskProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const replicationTaskProps: ReplicationTaskProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | migrationType | string | The migration type. | | replicationInstanceArn | string | The Amazon Resource Name (ARN) of a replication instance. | | sourceEndpointArn | string | An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. | | tableMappings | string | The table mappings for the task, in JSON format. | | targetEndpointArn | string | An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. | | cdcStartPosition | string | Indicates when you want a change data capture (CDC) operation to start. | | cdcStartTime | number | Indicates the start time for a change data capture (CDC) operation. | | cdcStopPosition | string | Indicates when you want a change data capture (CDC) operation to stop. | | replicationTaskIdentifier | string | An identifier for the replication task. | | replicationTaskSettings | string | Overall settings for the task, in JSON format. | | resourceIdentifier | string | A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. | | tags | aws-cdk-lib.CfnTag[] | One or more tags to be assigned to the replication task. | | taskData | string | Supplemental information that the task requires to migrate the data for certain source and target endpoints. | | replicationInstanceIdentifier | string | The identifier of the replication instance. | --- ##### `migrationType`^Required ```typescript public readonly migrationType: string; ``` - *Type:* string The migration type. Valid values: `full-load` | `cdc` | `full-load-and-cdc` > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype) --- ##### `replicationInstanceArn`^Required ```typescript public readonly replicationInstanceArn: string; ``` - *Type:* string The Amazon Resource Name (ARN) of a replication instance. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn) --- ##### `sourceEndpointArn`^Required ```typescript public readonly sourceEndpointArn: string; ``` - *Type:* string An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn) --- ##### `tableMappings`^Required ```typescript public readonly tableMappings: string; ``` - *Type:* string The table mappings for the task, in JSON format. For more information, see [Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the *AWS Database Migration Service User Guide* . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings) --- ##### `targetEndpointArn`^Required ```typescript public readonly targetEndpointArn: string; ``` - *Type:* string An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn) --- ##### `cdcStartPosition`^Optional ```typescript public readonly cdcStartPosition: string; ``` - *Type:* string Indicates when you want a change data capture (CDC) operation to start. Use either `CdcStartPosition` or `CdcStartTime` to specify when you want a CDC operation to start. Specifying both values results in an error. The value can be in date, checkpoint, log sequence number (LSN), or system change number (SCN) format. Here is a date example: `--cdc-start-position "2018-03-08T12:12:12"` Here is a checkpoint example: `--cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"` Here is an LSN example: `--cdc-start-position “mysql-bin-changelog.000024:373”` > When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot. For more information, see [Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition) --- ##### `cdcStartTime`^Optional ```typescript public readonly cdcStartTime: number; ``` - *Type:* number Indicates the start time for a change data capture (CDC) operation. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime) --- ##### `cdcStopPosition`^Optional ```typescript public readonly cdcStopPosition: string; ``` - *Type:* string Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Here is a server time example: `--cdc-stop-position "server_time:2018-02-09T12:12:12"` Here is a commit time example: `--cdc-stop-position "commit_time: 2018-02-09T12:12:12"` > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition) --- ##### `replicationTaskIdentifier`^Optional ```typescript public readonly replicationTaskIdentifier: string; ``` - *Type:* string An identifier for the replication task. Constraints: - Must contain 1-255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier) --- ##### `replicationTaskSettings`^Optional ```typescript public readonly replicationTaskSettings: string; ``` - *Type:* string Overall settings for the task, in JSON format. For more information, see [Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the *AWS Database Migration Service User Guide* . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings) --- ##### `resourceIdentifier`^Optional ```typescript public readonly resourceIdentifier: string; ``` - *Type:* string A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1` . For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1` . If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn` . > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-resourceidentifier](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-resourceidentifier) --- ##### `tags`^Optional ```typescript public readonly tags: CfnTag[]; ``` - *Type:* aws-cdk-lib.CfnTag[] One or more tags to be assigned to the replication task. > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags) --- ##### `taskData`^Optional ```typescript public readonly taskData: string; ``` - *Type:* string Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see [Specifying Supplemental Data for Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in the *AWS Database Migration Service User Guide.* > [http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata) --- ##### `replicationInstanceIdentifier`^Required ```typescript public readonly replicationInstanceIdentifier: string; ``` - *Type:* string The identifier of the replication instance. --- ### S3Bucket4xxErrorsAlarmConfig Configuration for the 4xx errors alarm. #### Initializer ```typescript import { S3Bucket4xxErrorsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const s3Bucket4xxErrorsAlarmConfig: S3Bucket4xxErrorsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The alarm description. | | alarmName | string | The alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0.05 The value against which the specified statistic is compared. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps us report the total number of 4xx error status codes that are made in response to client requests. 403 error codes might indicate an incorrect IAM policy, and 404 error codes might indicate mis-behaving client application, for example. Enabling S3 server access logging on a temporary basis will help you to pinpoint the issue's origin using the fields HTTP status and Error Code. To understand more about the error code, see Error Responses (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html). The alarm description. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* bucket.bucketName + ' - 4xxErrors' The alarm name. --- ### S3Bucket4xxErrorsAlarmProps Properties for the S3Bucket4xxErrorsAlarm construct. #### Initializer ```typescript import { S3Bucket4xxErrorsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const s3Bucket4xxErrorsAlarmProps: S3Bucket4xxErrorsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The alarm description. | | alarmName | string | The alarm name. | | bucket | aws-cdk-lib.aws_s3.IBucket | The S3 bucket to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0.05 The value against which the specified statistic is compared. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps us report the total number of 4xx error status codes that are made in response to client requests. 403 error codes might indicate an incorrect IAM policy, and 404 error codes might indicate mis-behaving client application, for example. Enabling S3 server access logging on a temporary basis will help you to pinpoint the issue's origin using the fields HTTP status and Error Code. To understand more about the error code, see Error Responses (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html). The alarm description. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* bucket.bucketName + ' - 4xxErrors' The alarm name. --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket The S3 bucket to monitor. --- ### S3Bucket5xxErrorsAlarmConfig Configuration for the 5xx errors alarm. #### Initializer ```typescript import { S3Bucket5xxErrorsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const s3Bucket5xxErrorsAlarmConfig: S3Bucket5xxErrorsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The alarm description. | | alarmName | string | The alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0.05 The value against which the specified statistic is compared. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps you detect a high number of server-side errors. These errors indicate that a client made a request that the server couldn’t complete. This can help you correlate the issue your application is facing because of S3. For more information to help you efficiently handle or reduce errors, see Optimizing performance design patterns (https://docs.aws.amazon.com/AmazonS3/latest/userguide/optimizing-performance-design-patterns.html#optimizing-performance-timeouts-retries). Errors might also be caused by an the issue with S3, check AWS service health dashboard for the status of Amazon S3 in your Region. The alarm description. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* bucket.bucketName + ' - 5xxErrors' The alarm name. --- ### S3Bucket5xxErrorsAlarmProps Properties for the S3Bucket5xxErrorsAlarm construct. #### Initializer ```typescript import { S3Bucket5xxErrorsAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const s3Bucket5xxErrorsAlarmProps: S3Bucket5xxErrorsAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The alarm description. | | alarmName | string | The alarm name. | | bucket | aws-cdk-lib.aws_s3.IBucket | The S3 bucket to monitor. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0.05 The value against which the specified statistic is compared. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps you detect a high number of server-side errors. These errors indicate that a client made a request that the server couldn’t complete. This can help you correlate the issue your application is facing because of S3. For more information to help you efficiently handle or reduce errors, see Optimizing performance design patterns (https://docs.aws.amazon.com/AmazonS3/latest/userguide/optimizing-performance-design-patterns.html#optimizing-performance-timeouts-retries). Errors might also be caused by an the issue with S3, check AWS service health dashboard for the status of Amazon S3 in your Region. The alarm description. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* bucket.bucketName + ' - 5xxErrors' The alarm name. --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket The S3 bucket to monitor. --- ### S3BucketHttpErrorsAlarmConfig The optional configuration for the 4xx and 5xx error alarms for an S3 bucket. #### Initializer ```typescript import { S3BucketHttpErrorsAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const s3BucketHttpErrorsAlarmConfig: S3BucketHttpErrorsAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0.05 The value against which the specified statistic is compared. --- ### S3RecommendedAlarmsConfig Configurations for the recommended alarms for an S3 bucket. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { S3RecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const s3RecommendedAlarmsConfig: S3RecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config4xxErrorsAlarm | S3Bucket4xxErrorsAlarmConfig | The configuration for the 4xx errors alarm. | | config5xxErrorsAlarm | S3Bucket5xxErrorsAlarmConfig | The configuration for the 5xx errors alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | S3RecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `config4xxErrorsAlarm`^Optional ```typescript public readonly config4xxErrorsAlarm: S3Bucket4xxErrorsAlarmConfig; ``` - *Type:* S3Bucket4xxErrorsAlarmConfig The configuration for the 4xx errors alarm. --- ##### `config5xxErrorsAlarm`^Optional ```typescript public readonly config5xxErrorsAlarm: S3Bucket5xxErrorsAlarmConfig; ``` - *Type:* S3Bucket5xxErrorsAlarmConfig The configuration for the 5xx errors alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: S3RecommendedAlarmsMetrics[]; ``` - *Type:* S3RecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### S3RecommendedAlarmsProps #### Initializer ```typescript import { S3RecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const s3RecommendedAlarmsProps: S3RecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | config4xxErrorsAlarm | S3Bucket4xxErrorsAlarmConfig | The configuration for the 4xx errors alarm. | | config5xxErrorsAlarm | S3Bucket5xxErrorsAlarmConfig | The configuration for the 5xx errors alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | S3RecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | bucket | aws-cdk-lib.aws_s3.IBucket | The S3 bucket to apply the recommended alarms to. | --- ##### `config4xxErrorsAlarm`^Optional ```typescript public readonly config4xxErrorsAlarm: S3Bucket4xxErrorsAlarmConfig; ``` - *Type:* S3Bucket4xxErrorsAlarmConfig The configuration for the 4xx errors alarm. --- ##### `config5xxErrorsAlarm`^Optional ```typescript public readonly config5xxErrorsAlarm: S3Bucket5xxErrorsAlarmConfig; ``` - *Type:* S3Bucket5xxErrorsAlarmConfig The configuration for the 5xx errors alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: S3RecommendedAlarmsMetrics[]; ``` - *Type:* S3RecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `bucket`^Required ```typescript public readonly bucket: IBucket; ``` - *Type:* aws-cdk-lib.aws_s3.IBucket The S3 bucket to apply the recommended alarms to. --- ### SfAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { SfAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfAlarmBaseConfig: SfAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### SfStateMachineAlarmProps The common properties for the StepFunctions StateMachine alarms. #### Initializer ```typescript import { SfStateMachineAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineAlarmProps: SfStateMachineAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | The StateMachine to monitor. | --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine The StateMachine to monitor. --- ### SfStateMachineExecutionsFailedAlarmConfig Configuration for the ExecutionsFailed alarm. #### Initializer ```typescript import { SfStateMachineExecutionsFailedAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineExecutionsFailedAlarmConfig: SfStateMachineExecutionsFailedAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | It helps in tracking the number of executions that fail in AWS Step Functions. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect workflows that are not working as expected. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* stateMachineName + ' - ExecutionsFailed' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 5 It helps in tracking the number of executions that fail in AWS Step Functions. This is crucial for identifying workflows that are not performing as expected and require attention. By monitoring the failures, developers can proactively identify and resolve issues before they impact the business operations. This reduces downtime and improves the overall stability of applications. --- ### SfStateMachineExecutionsFailedAlarmProps The properties for the SfStateMachineExecutionsFailedAlarm construct. #### Initializer ```typescript import { SfStateMachineExecutionsFailedAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineExecutionsFailedAlarmProps: SfStateMachineExecutionsFailedAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | The StateMachine to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | It helps in tracking the number of executions that fail in AWS Step Functions. | --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine The StateMachine to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect workflows that are not working as expected. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* stateMachineName + ' - ExecutionsFailed' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 5 It helps in tracking the number of executions that fail in AWS Step Functions. This is crucial for identifying workflows that are not performing as expected and require attention. By monitoring the failures, developers can proactively identify and resolve issues before they impact the business operations. This reduces downtime and improves the overall stability of applications. --- ### SfStateMachineExecutionsTimedOutAlarmConfig Configuration for the ExecutionsTimedOut alarm. #### Initializer ```typescript import { SfStateMachineExecutionsTimedOutAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineExecutionsTimedOutAlarmConfig: SfStateMachineExecutionsTimedOutAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | It helps in identifying timeouts in state machine executions, which can indicate problems like poor configuration, inadequate resource allocation, or issues in the called services that need addressing. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps in identifying timeouts in state machine executions due to poor configuration, inadequate resource allocation, or issues in the called services that need addressing. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* stateMachineName + ' - ExecutionsTimedOut' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 5 It helps in identifying timeouts in state machine executions, which can indicate problems like poor configuration, inadequate resource allocation, or issues in the called services that need addressing. --- ### SfStateMachineExecutionsTimedOutAlarmProps The properties for the SfStateMachineExecutionsTimedOutAlarm construct. #### Initializer ```typescript import { SfStateMachineExecutionsTimedOutAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineExecutionsTimedOutAlarmProps: SfStateMachineExecutionsTimedOutAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | The StateMachine to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | It helps in identifying timeouts in state machine executions, which can indicate problems like poor configuration, inadequate resource allocation, or issues in the called services that need addressing. | --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine The StateMachine to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps in identifying timeouts in state machine executions due to poor configuration, inadequate resource allocation, or issues in the called services that need addressing. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* stateMachineName + ' - ExecutionsTimedOut' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 5 It helps in identifying timeouts in state machine executions, which can indicate problems like poor configuration, inadequate resource allocation, or issues in the called services that need addressing. --- ### SfStateMachineExecutionThrottledAlarmConfig Configuration for the ExecutionThrottled alarm. #### Initializer ```typescript import { SfStateMachineExecutionThrottledAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineExecutionThrottledAlarmConfig: SfStateMachineExecutionThrottledAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The ExecutionThrottled metric tracks the number of times state machine executions are throttled due to exceeding AWS service limits. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect throttled executions due to exceeding AWS service limits. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* stateMachineName + ' - ExecutionThrottled' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 5 The ExecutionThrottled metric tracks the number of times state machine executions are throttled due to exceeding AWS service limits. Monitoring this can help you identify when you are hitting this limits, which could signal that adjustments need to be made either in the process design or in the service limits themselves. --- ### SfStateMachineExecutionThrottledAlarmProps The properties for the SfStateMachineExecutionThrottledAlarm construct. #### Initializer ```typescript import { SfStateMachineExecutionThrottledAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineExecutionThrottledAlarmProps: SfStateMachineExecutionThrottledAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | The StateMachine to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | The ExecutionThrottled metric tracks the number of times state machine executions are throttled due to exceeding AWS service limits. | --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine The StateMachine to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect throttled executions due to exceeding AWS service limits. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* stateMachineName + ' - ExecutionThrottled' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 5 The ExecutionThrottled metric tracks the number of times state machine executions are throttled due to exceeding AWS service limits. Monitoring this can help you identify when you are hitting this limits, which could signal that adjustments need to be made either in the process design or in the service limits themselves. --- ### SfStateMachineExecutionTimeAlarmConfig Configuration for the ExecutionTime alarm. #### Initializer ```typescript import { SfStateMachineExecutionTimeAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineExecutionTimeAlarmConfig: SfStateMachineExecutionTimeAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | A sudden increase in execution time might indicate issues with the steps of the resources they interact with. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* None A sudden increase in execution time might indicate issues with the steps of the resources they interact with. Consider setting a threshold (in milliseconds) that is appropriate for the expected execution time of the state machine. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect sudden increases in execution time.. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* stateMachineName + ' - ExecutionTime' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### SfStateMachineExecutionTimeAlarmProps The properties for the SfStateMachineExecutionTimeAlarm construct. #### Initializer ```typescript import { SfStateMachineExecutionTimeAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineExecutionTimeAlarmProps: SfStateMachineExecutionTimeAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | The StateMachine to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | A sudden increase in execution time might indicate issues with the steps of the resources they interact with. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine The StateMachine to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* None A sudden increase in execution time might indicate issues with the steps of the resources they interact with. Consider setting a threshold (in milliseconds) that is appropriate for the expected execution time of the state machine. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect sudden increases in execution time.. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* stateMachineName + ' - ExecutionTime' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ### SfStateMachineRecommendedAlarmsConfig Configurations for the recommended alarms for an StepFunctions Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { SfStateMachineRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineRecommendedAlarmsConfig: SfStateMachineRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configExecutionTimeAlarm | SfStateMachineExecutionTimeAlarmConfig | The configuration for the ExecutionTime alarm. | | configExecutionsFailedAlarm | SfStateMachineExecutionsFailedAlarmConfig | The configuration for the ExecutionsFailed alarm. | | configExecutionsTimedOutAlarm | SfStateMachineExecutionsTimedOutAlarmConfig | The configuration for the ExecutionsFailed alarm. | | configExecutionThrottledAlarm | SfStateMachineExecutionThrottledAlarmConfig | The configuration for the ExecutionThrottled alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | SfRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configExecutionTimeAlarm`^Required ```typescript public readonly configExecutionTimeAlarm: SfStateMachineExecutionTimeAlarmConfig; ``` - *Type:* SfStateMachineExecutionTimeAlarmConfig The configuration for the ExecutionTime alarm. --- ##### `configExecutionsFailedAlarm`^Optional ```typescript public readonly configExecutionsFailedAlarm: SfStateMachineExecutionsFailedAlarmConfig; ``` - *Type:* SfStateMachineExecutionsFailedAlarmConfig The configuration for the ExecutionsFailed alarm. --- ##### `configExecutionsTimedOutAlarm`^Optional ```typescript public readonly configExecutionsTimedOutAlarm: SfStateMachineExecutionsTimedOutAlarmConfig; ``` - *Type:* SfStateMachineExecutionsTimedOutAlarmConfig The configuration for the ExecutionsFailed alarm. --- ##### `configExecutionThrottledAlarm`^Optional ```typescript public readonly configExecutionThrottledAlarm: SfStateMachineExecutionThrottledAlarmConfig; ``` - *Type:* SfStateMachineExecutionThrottledAlarmConfig The configuration for the ExecutionThrottled alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: SfRecommendedAlarmsMetrics[]; ``` - *Type:* SfRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### SfStateMachineRecommendedAlarmsProps Properties for the SfStateMachineRecommendedAlarms construct. #### Initializer ```typescript import { SfStateMachineRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sfStateMachineRecommendedAlarmsProps: SfStateMachineRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configExecutionTimeAlarm | SfStateMachineExecutionTimeAlarmConfig | The configuration for the ExecutionTime alarm. | | configExecutionsFailedAlarm | SfStateMachineExecutionsFailedAlarmConfig | The configuration for the ExecutionsFailed alarm. | | configExecutionsTimedOutAlarm | SfStateMachineExecutionsTimedOutAlarmConfig | The configuration for the ExecutionsFailed alarm. | | configExecutionThrottledAlarm | SfStateMachineExecutionThrottledAlarmConfig | The configuration for the ExecutionThrottled alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | SfRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | stateMachine | aws-cdk-lib.aws_stepfunctions.StateMachine | The EFS StateMachine to monitor. | --- ##### `configExecutionTimeAlarm`^Required ```typescript public readonly configExecutionTimeAlarm: SfStateMachineExecutionTimeAlarmConfig; ``` - *Type:* SfStateMachineExecutionTimeAlarmConfig The configuration for the ExecutionTime alarm. --- ##### `configExecutionsFailedAlarm`^Optional ```typescript public readonly configExecutionsFailedAlarm: SfStateMachineExecutionsFailedAlarmConfig; ``` - *Type:* SfStateMachineExecutionsFailedAlarmConfig The configuration for the ExecutionsFailed alarm. --- ##### `configExecutionsTimedOutAlarm`^Optional ```typescript public readonly configExecutionsTimedOutAlarm: SfStateMachineExecutionsTimedOutAlarmConfig; ``` - *Type:* SfStateMachineExecutionsTimedOutAlarmConfig The configuration for the ExecutionsFailed alarm. --- ##### `configExecutionThrottledAlarm`^Optional ```typescript public readonly configExecutionThrottledAlarm: SfStateMachineExecutionThrottledAlarmConfig; ``` - *Type:* SfStateMachineExecutionThrottledAlarmConfig The configuration for the ExecutionThrottled alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: SfRecommendedAlarmsMetrics[]; ``` - *Type:* SfRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `stateMachine`^Required ```typescript public readonly stateMachine: StateMachine; ``` - *Type:* aws-cdk-lib.aws_stepfunctions.StateMachine The EFS StateMachine to monitor. --- ### SnsAlarmBaseConfig #### Initializer ```typescript import { SnsAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsAlarmBaseConfig: SnsAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### SnsNumberOfMessagesPublishedAlarmConfig Configuration for the NumberOfMessagesPublished alarm. #### Initializer ```typescript import { SnsNumberOfMessagesPublishedAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfMessagesPublishedAlarmConfig: SnsNumberOfMessagesPublishedAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The number of messages published should be in line with the expected number of published messages for your application. You can also analyze the historical data, trends and traffic to find the right threshold. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the number of SNS messages published is too low. For troubleshooting, check why the publishers are sending less traffic. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfMessagesPublished' The alarm name. --- ### SnsNumberOfMessagesPublishedAlarmProps Properties for the SnsNumberOfMessagesPublishedAlarm construct. #### Initializer ```typescript import { SnsNumberOfMessagesPublishedAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfMessagesPublishedAlarmProps: SnsNumberOfMessagesPublishedAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | topic | aws-cdk-lib.aws_sns.ITopic | The SNS topic for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The number of messages published should be in line with the expected number of published messages for your application. You can also analyze the historical data, trends and traffic to find the right threshold. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the number of SNS messages published is too low. For troubleshooting, check why the publishers are sending less traffic. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfMessagesPublished' The alarm name. --- ##### `topic`^Required ```typescript public readonly topic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The SNS topic for which to create the alarm. --- ### SnsNumberOfNotificationsDeliveredAlarmConfig Configuration for the NumberOfNotificationsDelivered alarm. #### Initializer ```typescript import { SnsNumberOfNotificationsDeliveredAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsDeliveredAlarmConfig: SnsNumberOfNotificationsDeliveredAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The number of messages delivered should be in line with the expected number of messages produced and the number of consumers. You can also analyze the historical data, trends and traffic to find the right threshold. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the number of SNS messages delivered is too low. This could be because of unintentional unsubscribing of an endpoint, or because of an SNS event that causes messages to experience delay. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsDelivered' The alarm name. --- ### SnsNumberOfNotificationsDeliveredAlarmProps Properties for the SnsNumberOfNotificationsDeliveredAlarm construct. #### Initializer ```typescript import { SnsNumberOfNotificationsDeliveredAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsDeliveredAlarmProps: SnsNumberOfNotificationsDeliveredAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | topic | aws-cdk-lib.aws_sns.ITopic | The SNS topic for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The number of messages delivered should be in line with the expected number of messages produced and the number of consumers. You can also analyze the historical data, trends and traffic to find the right threshold. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the number of SNS messages delivered is too low. This could be because of unintentional unsubscribing of an endpoint, or because of an SNS event that causes messages to experience delay. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsDelivered' The alarm name. --- ##### `topic`^Required ```typescript public readonly topic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The SNS topic for which to create the alarm. --- ### SnsNumberOfNotificationsFailedAlarmConfig Configuration for the NumberOfNotificationsFailed alarm. #### Initializer ```typescript import { SnsNumberOfNotificationsFailedAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsFailedAlarmConfig: SnsNumberOfNotificationsFailedAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on the impact of failed notifications. Review the SLAs provided to your end users, fault tolerance and criticality of notifications and analyze historical data, and then select a threshold accordingly. The number of notifications failed should be 0 for topics that have only SQS, Lambda or Firehose subscriptions. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the number of failed SNS messages is too high. To troubleshoot failed notifications, enable logging to CloudWatch Logs. Checking the logs can help you find which subscribers are failing, as well as the status codes they are returning. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsFailed' The alarm name. --- ### SnsNumberOfNotificationsFailedAlarmProps Properties for the SnsNumberOfNotificationsFailedAlarm construct. #### Initializer ```typescript import { SnsNumberOfNotificationsFailedAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsFailedAlarmProps: SnsNumberOfNotificationsFailedAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | topic | aws-cdk-lib.aws_sns.ITopic | The SNS topic for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on the impact of failed notifications. Review the SLAs provided to your end users, fault tolerance and criticality of notifications and analyze historical data, and then select a threshold accordingly. The number of notifications failed should be 0 for topics that have only SQS, Lambda or Firehose subscriptions. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm can detect when the number of failed SNS messages is too high. To troubleshoot failed notifications, enable logging to CloudWatch Logs. Checking the logs can help you find which subscribers are failing, as well as the status codes they are returning. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsFailed' The alarm name. --- ##### `topic`^Required ```typescript public readonly topic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The SNS topic for which to create the alarm. --- ### SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig Configuration for the NumberOfNotificationsFailedToRedriveToDlq alarm. #### Initializer ```typescript import { SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig: SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor messages that couldn't be moved to a dead-letter queue. Check whether your dead-letter queue exists and that it's configured correctly. Also, verify that SNS has permissions to access the dead-letter queue. Refer to the dead-letter queue documentation (https://docs.aws.amazon.com/sns/latest/dg/sns-dead-letter-queues.html) to learn more. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsFailedToRedriveToDlq' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. It's almost always a mistake if messages can't be moved to the dead-letter queue. The recommendation for the threshold is 0, meaning all messages that fail processing must be able to reach the dead-letter queue when the queue has been configured. --- ### SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps Properties for the SnsNumberOfNotificationsFailedToRedriveToDlqAlarm construct. #### Initializer ```typescript import { SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsFailedToRedriveToDlqAlarmProps: SnsNumberOfNotificationsFailedToRedriveToDlqAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | | topic | aws-cdk-lib.aws_sns.ITopic | The SNS topic for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor messages that couldn't be moved to a dead-letter queue. Check whether your dead-letter queue exists and that it's configured correctly. Also, verify that SNS has permissions to access the dead-letter queue. Refer to the dead-letter queue documentation (https://docs.aws.amazon.com/sns/latest/dg/sns-dead-letter-queues.html) to learn more. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsFailedToRedriveToDlq' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. It's almost always a mistake if messages can't be moved to the dead-letter queue. The recommendation for the threshold is 0, meaning all messages that fail processing must be able to reach the dead-letter queue when the queue has been configured. --- ##### `topic`^Required ```typescript public readonly topic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The SNS topic for which to create the alarm. --- ### SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig Configuration for the NumberOfNotificationsFilteredOutInvalidAttributes alarm. #### Initializer ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig: SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor and resolve potential problems with the publisher or subscribers. Check if a publisher is publishing messages with invalid attributes or if an inappropriate filter is applied to a subscriber. You can also analyze CloudWatch Logs to help find the root cause of the issue. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsFilteredOut-InvalidAttributes' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. Invalid attributes are almost always a mistake by the publisher. We recommend to set the threshold to 0 because invalid attributes are not expected in a healthy system. --- ### SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps Properties for the SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarm construct. #### Initializer ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps: SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | | topic | aws-cdk-lib.aws_sns.ITopic | The SNS topic for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor and resolve potential problems with the publisher or subscribers. Check if a publisher is publishing messages with invalid attributes or if an inappropriate filter is applied to a subscriber. You can also analyze CloudWatch Logs to help find the root cause of the issue. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsFilteredOut-InvalidAttributes' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. Invalid attributes are almost always a mistake by the publisher. We recommend to set the threshold to 0 because invalid attributes are not expected in a healthy system. --- ##### `topic`^Required ```typescript public readonly topic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The SNS topic for which to create the alarm. --- ### SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig Configuration for the NumberOfNotificationsFilteredOutInvalidMessageBody alarm. #### Initializer ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig: SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor and resolve potential problems with the publisher or subscribers. Check if a publisher is publishing messages with invalid message bodies, or if an inappropriate filter is applied to a subscriber. You can also analyze CloudWatch Logs to help find the root cause of the issue. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsFilteredOut-InvalidMessageBody' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. Invalid message bodies are almost always a mistake by the publisher. We recommend to set the threshold to 0 because invalid message bodies are not expected in a healthy system. --- ### SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps Properties for the SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm construct. #### Initializer ```typescript import { SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps: SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | | topic | aws-cdk-lib.aws_sns.ITopic | The SNS topic for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor and resolve potential problems with the publisher or subscribers. Check if a publisher is publishing messages with invalid message bodies, or if an inappropriate filter is applied to a subscriber. You can also analyze CloudWatch Logs to help find the root cause of the issue. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsFilteredOut-InvalidMessageBody' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. Invalid message bodies are almost always a mistake by the publisher. We recommend to set the threshold to 0 because invalid message bodies are not expected in a healthy system. --- ##### `topic`^Required ```typescript public readonly topic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The SNS topic for which to create the alarm. --- ### SnsNumberOfNotificationsRedrivenToDlqAlarmConfig Configuration for the NumberOfNotificationsRedrivenToDlq alarm. #### Initializer ```typescript import { SnsNumberOfNotificationsRedrivenToDlqAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsRedrivenToDlqAlarmConfig: SnsNumberOfNotificationsRedrivenToDlqAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor the number of messages that are moved to a dead-letter queue. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsRedrivenToDlq' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. In a healthy system of any subscriber type, messages should not be moved to the dead-letter queue. We recommend that you be notified if any messages land in the queue, so that you can identify and address the root cause, and potentially redrive the messages in the dead-letter queue to prevent data loss. --- ### SnsNumberOfNotificationsRedrivenToDlqAlarmProps Properties for the SnsNumberOfNotificationsRedrivenToDlqAlarm construct. #### Initializer ```typescript import { SnsNumberOfNotificationsRedrivenToDlqAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsNumberOfNotificationsRedrivenToDlqAlarmProps: SnsNumberOfNotificationsRedrivenToDlqAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | | topic | aws-cdk-lib.aws_sns.ITopic | The SNS topic for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 5 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 5 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to monitor the number of messages that are moved to a dead-letter queue. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* topic.topicName + ' - NumberOfNotificationsRedrivenToDlq' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. In a healthy system of any subscriber type, messages should not be moved to the dead-letter queue. We recommend that you be notified if any messages land in the queue, so that you can identify and address the root cause, and potentially redrive the messages in the dead-letter queue to prevent data loss. --- ##### `topic`^Required ```typescript public readonly topic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The SNS topic for which to create the alarm. --- ### SnsRecommendedAlarmsConfig #### Initializer ```typescript import { SnsRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsRecommendedAlarmsConfig: SnsRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configNumberOfMessagesPublishedAlarm | SnsNumberOfMessagesPublishedAlarmConfig | The configuration for the NumberOfMessagesPublished alarm. | | configNumberOfNotificationsDeliveredAlarm | SnsNumberOfNotificationsDeliveredAlarmConfig | The configuration for the NumberOfNotificationsDelivered alarm. | | configNumberOfNotificationsFailedAlarm | SnsNumberOfNotificationsFailedAlarmConfig | The configuration for the NumberOfNotificationsFailed alarm. | | configNumberOfNotificationsFailedToRedriveToDlqAlarm | SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig | The configuration for the NumberOfNotificationsFailedToRedriveToDlq alarm. | | configNumberOfNotificationsFilteredOutInvalidAttributesAlarm | SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig | The configuration for the NumberOfNotificationsFilteredOutInvalidAttributes alarm. | | configNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm | SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig | The configuration for the NumberOfNotificationsFilteredOutInvalidMessageBody alarm. | | configNumberOfNotificationsRedrivenToDlqAlarm | SnsNumberOfNotificationsRedrivenToDlqAlarmConfig | The configuration for the NumberOfNotificationsRedrivenToDlq alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | SnsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configNumberOfMessagesPublishedAlarm`^Required ```typescript public readonly configNumberOfMessagesPublishedAlarm: SnsNumberOfMessagesPublishedAlarmConfig; ``` - *Type:* SnsNumberOfMessagesPublishedAlarmConfig The configuration for the NumberOfMessagesPublished alarm. --- ##### `configNumberOfNotificationsDeliveredAlarm`^Required ```typescript public readonly configNumberOfNotificationsDeliveredAlarm: SnsNumberOfNotificationsDeliveredAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsDeliveredAlarmConfig The configuration for the NumberOfNotificationsDelivered alarm. --- ##### `configNumberOfNotificationsFailedAlarm`^Required ```typescript public readonly configNumberOfNotificationsFailedAlarm: SnsNumberOfNotificationsFailedAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsFailedAlarmConfig The configuration for the NumberOfNotificationsFailed alarm. --- ##### `configNumberOfNotificationsFailedToRedriveToDlqAlarm`^Optional ```typescript public readonly configNumberOfNotificationsFailedToRedriveToDlqAlarm: SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig The configuration for the NumberOfNotificationsFailedToRedriveToDlq alarm. --- ##### `configNumberOfNotificationsFilteredOutInvalidAttributesAlarm`^Optional ```typescript public readonly configNumberOfNotificationsFilteredOutInvalidAttributesAlarm: SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig The configuration for the NumberOfNotificationsFilteredOutInvalidAttributes alarm. --- ##### `configNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm`^Optional ```typescript public readonly configNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm: SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig The configuration for the NumberOfNotificationsFilteredOutInvalidMessageBody alarm. --- ##### `configNumberOfNotificationsRedrivenToDlqAlarm`^Optional ```typescript public readonly configNumberOfNotificationsRedrivenToDlqAlarm: SnsNumberOfNotificationsRedrivenToDlqAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsRedrivenToDlqAlarmConfig The configuration for the NumberOfNotificationsRedrivenToDlq alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: SnsRecommendedAlarmsMetrics[]; ``` - *Type:* SnsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### SnsRecommendedAlarmsProps #### Initializer ```typescript import { SnsRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const snsRecommendedAlarmsProps: SnsRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configNumberOfMessagesPublishedAlarm | SnsNumberOfMessagesPublishedAlarmConfig | The configuration for the NumberOfMessagesPublished alarm. | | configNumberOfNotificationsDeliveredAlarm | SnsNumberOfNotificationsDeliveredAlarmConfig | The configuration for the NumberOfNotificationsDelivered alarm. | | configNumberOfNotificationsFailedAlarm | SnsNumberOfNotificationsFailedAlarmConfig | The configuration for the NumberOfNotificationsFailed alarm. | | configNumberOfNotificationsFailedToRedriveToDlqAlarm | SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig | The configuration for the NumberOfNotificationsFailedToRedriveToDlq alarm. | | configNumberOfNotificationsFilteredOutInvalidAttributesAlarm | SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig | The configuration for the NumberOfNotificationsFilteredOutInvalidAttributes alarm. | | configNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm | SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig | The configuration for the NumberOfNotificationsFilteredOutInvalidMessageBody alarm. | | configNumberOfNotificationsRedrivenToDlqAlarm | SnsNumberOfNotificationsRedrivenToDlqAlarmConfig | The configuration for the NumberOfNotificationsRedrivenToDlq alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | SnsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | topic | aws-cdk-lib.aws_sns.ITopic | The SNS topic for which to create the alarms. | --- ##### `configNumberOfMessagesPublishedAlarm`^Required ```typescript public readonly configNumberOfMessagesPublishedAlarm: SnsNumberOfMessagesPublishedAlarmConfig; ``` - *Type:* SnsNumberOfMessagesPublishedAlarmConfig The configuration for the NumberOfMessagesPublished alarm. --- ##### `configNumberOfNotificationsDeliveredAlarm`^Required ```typescript public readonly configNumberOfNotificationsDeliveredAlarm: SnsNumberOfNotificationsDeliveredAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsDeliveredAlarmConfig The configuration for the NumberOfNotificationsDelivered alarm. --- ##### `configNumberOfNotificationsFailedAlarm`^Required ```typescript public readonly configNumberOfNotificationsFailedAlarm: SnsNumberOfNotificationsFailedAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsFailedAlarmConfig The configuration for the NumberOfNotificationsFailed alarm. --- ##### `configNumberOfNotificationsFailedToRedriveToDlqAlarm`^Optional ```typescript public readonly configNumberOfNotificationsFailedToRedriveToDlqAlarm: SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsFailedToRedriveToDlqAlarmConfig The configuration for the NumberOfNotificationsFailedToRedriveToDlq alarm. --- ##### `configNumberOfNotificationsFilteredOutInvalidAttributesAlarm`^Optional ```typescript public readonly configNumberOfNotificationsFilteredOutInvalidAttributesAlarm: SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsFilteredOutInvalidAttributesAlarmConfig The configuration for the NumberOfNotificationsFilteredOutInvalidAttributes alarm. --- ##### `configNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm`^Optional ```typescript public readonly configNumberOfNotificationsFilteredOutInvalidMessageBodyAlarm: SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsFilteredOutInvalidMessageBodyAlarmConfig The configuration for the NumberOfNotificationsFilteredOutInvalidMessageBody alarm. --- ##### `configNumberOfNotificationsRedrivenToDlqAlarm`^Optional ```typescript public readonly configNumberOfNotificationsRedrivenToDlqAlarm: SnsNumberOfNotificationsRedrivenToDlqAlarmConfig; ``` - *Type:* SnsNumberOfNotificationsRedrivenToDlqAlarmConfig The configuration for the NumberOfNotificationsRedrivenToDlq alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: SnsRecommendedAlarmsMetrics[]; ``` - *Type:* SnsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `topic`^Required ```typescript public readonly topic: ITopic; ``` - *Type:* aws-cdk-lib.aws_sns.ITopic The SNS topic for which to create the alarms. --- ### SqsAlarmBaseConfig #### Initializer ```typescript import { SqsAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsAlarmBaseConfig: SqsAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ### SqsApproximateAgeOfOldestMessageAlarmConfig Configuration for the ApproximateAgeOfOldestMessage alarm. #### Initializer ```typescript import { SqsApproximateAgeOfOldestMessageAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsApproximateAgeOfOldestMessageAlarmConfig: SqsApproximateAgeOfOldestMessageAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on the expected message processing time. You can use historical data to calculate the average message processing time, and then set the threshold to 50% higher than the maximum expected SQS message processing time by queue consumers. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm watches the age of the oldest message in the queue. You can use this alarm to monitor if your consumers are processing SQS messages at the desired speed. Consider increasing the consumer count or consumer throughput to reduce message age. This metric can be used in combination with ApproximateNumberOfMessagesVisible to determine how big the queue backlog is and how quickly messages are being processed. To prevent messages from being deleted before processed, consider configuring the dead-letter queue to sideline potential poison pill messages. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* queue.queueName + ' - ApproximateAgeOfOldestMessage' The alarm name. --- ### SqsApproximateAgeOfOldestMessageAlarmProps Properties for the SqsApproximateAgeOfOldestMessageAlarm construct. #### Initializer ```typescript import { SqsApproximateAgeOfOldestMessageAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsApproximateAgeOfOldestMessageAlarmProps: SqsApproximateAgeOfOldestMessageAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | queue | aws-cdk-lib.aws_sqs.IQueue | The SQS queue for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on the expected message processing time. You can use historical data to calculate the average message processing time, and then set the threshold to 50% higher than the maximum expected SQS message processing time by queue consumers. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm watches the age of the oldest message in the queue. You can use this alarm to monitor if your consumers are processing SQS messages at the desired speed. Consider increasing the consumer count or consumer throughput to reduce message age. This metric can be used in combination with ApproximateNumberOfMessagesVisible to determine how big the queue backlog is and how quickly messages are being processed. To prevent messages from being deleted before processed, consider configuring the dead-letter queue to sideline potential poison pill messages. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* queue.queueName + ' - ApproximateAgeOfOldestMessage' The alarm name. --- ##### `queue`^Required ```typescript public readonly queue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue The SQS queue for which to create the alarm. --- ### SqsApproximateNumberOfMessagesNotVisibleAlarmConfig Configuration for the ApproximateNumberOfMessagesNotVisible alarm. #### Initializer ```typescript import { SqsApproximateNumberOfMessagesNotVisibleAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsApproximateNumberOfMessagesNotVisibleAlarmConfig: SqsApproximateNumberOfMessagesNotVisibleAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on the expected number of messages in flight. You can use historical data to calculate the maximum expected number of messages in flight and set the threshold to 50% over this value. If consumers of the queue are processing but not deleting messages from the queue, this number will suddenly increase. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to detect a high number of in-flight messages with respect to QueueName. For troubleshooting, check message backlog decreasing (https://repost.aws/knowledge-center/sqs-message-backlog). The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* queue.queueName + ' - ApproximateNumberOfMessagesNotVisible' The alarm name. --- ### SqsApproximateNumberOfMessagesNotVisibleAlarmProps Properties for the SqsApproximateNumberOfMessagesNotVisibleAlarm construct. #### Initializer ```typescript import { SqsApproximateNumberOfMessagesNotVisibleAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsApproximateNumberOfMessagesNotVisibleAlarmProps: SqsApproximateNumberOfMessagesNotVisibleAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | queue | aws-cdk-lib.aws_sqs.IQueue | The SQS queue for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. The recommended threshold value for this alarm is highly dependent on the expected number of messages in flight. You can use historical data to calculate the maximum expected number of messages in flight and set the threshold to 50% over this value. If consumers of the queue are processing but not deleting messages from the queue, this number will suddenly increase. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to detect a high number of in-flight messages with respect to QueueName. For troubleshooting, check message backlog decreasing (https://repost.aws/knowledge-center/sqs-message-backlog). The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* queue.queueName + ' - ApproximateNumberOfMessagesNotVisible' The alarm name. --- ##### `queue`^Required ```typescript public readonly queue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue The SQS queue for which to create the alarm. --- ### SqsApproximateNumberOfMessagesVisibleAlarmConfig Configuration for the ApproximateNumberOfMessagesVisible alarm. #### Initializer ```typescript import { SqsApproximateNumberOfMessagesVisibleAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsApproximateNumberOfMessagesVisibleAlarmConfig: SqsApproximateNumberOfMessagesVisibleAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. An unexpectedly high number of messages visible indicates that messages are not being processed by a consumer at the expected rate. You should consider historical data when you set this threshold. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to detect a high number of in-flight messages with respect to QueueName. For troubleshooting, check message backlog decreasing (https://repost.aws/knowledge-center/sqs-message-backlog). The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* queue.queueName + ' - ApproximateNumberOfMessagesVisible' The alarm name. --- ### SqsApproximateNumberOfMessagesVisibleAlarmProps Properties for the SqsApproximateNumberOfMessagesVisibleAlarm construct. #### Initializer ```typescript import { SqsApproximateNumberOfMessagesVisibleAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsApproximateNumberOfMessagesVisibleAlarmProps: SqsApproximateNumberOfMessagesVisibleAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | threshold | number | The value against which the specified statistic is compared. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | queue | aws-cdk-lib.aws_sqs.IQueue | The SQS queue for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `threshold`^Required ```typescript public readonly threshold: number; ``` - *Type:* number The value against which the specified statistic is compared. An unexpectedly high number of messages visible indicates that messages are not being processed by a consumer at the expected rate. You should consider historical data when you set this threshold. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to detect a high number of in-flight messages with respect to QueueName. For troubleshooting, check message backlog decreasing (https://repost.aws/knowledge-center/sqs-message-backlog). The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* queue.queueName + ' - ApproximateNumberOfMessagesVisible' The alarm name. --- ##### `queue`^Required ```typescript public readonly queue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue The SQS queue for which to create the alarm. --- ### SqsNumberOfMessagesSentAlarmConfig Configuration for the NumberOfMessagesSent alarm. #### Initializer ```typescript import { SqsNumberOfMessagesSentAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsNumberOfMessagesSentAlarmConfig: SqsNumberOfMessagesSentAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to detect a high number of in-flight messages with respect to QueueName. For troubleshooting, check message backlog decreasing (https://repost.aws/knowledge-center/sqs-message-backlog). The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* queue.queueName + ' - NumberOfMessagesSent' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. If the number of messages sent is 0, the producer is not sending any messages. If this queue has a low TPS, increase the number of EvaluationPeriods accordingly. --- ### SqsNumberOfMessagesSentAlarmProps Properties for the SqsNumberOfMessagesSentAlarm construct. #### Initializer ```typescript import { SqsNumberOfMessagesSentAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsNumberOfMessagesSentAlarmProps: SqsNumberOfMessagesSentAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | threshold | number | The value against which the specified statistic is compared. | | queue | aws-cdk-lib.aws_sqs.IQueue | The SQS queue for which to create the alarm. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 15 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 15 The number of periods over which data is compared to the specified threshold. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(1) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm helps to detect a high number of in-flight messages with respect to QueueName. For troubleshooting, check message backlog decreasing (https://repost.aws/knowledge-center/sqs-message-backlog). The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* queue.queueName + ' - NumberOfMessagesSent' The alarm name. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 0 The value against which the specified statistic is compared. If the number of messages sent is 0, the producer is not sending any messages. If this queue has a low TPS, increase the number of EvaluationPeriods accordingly. --- ##### `queue`^Required ```typescript public readonly queue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue The SQS queue for which to create the alarm. --- ### SqsRecommendedAlarmsConfig Configuration for the recommended alarms for an SQS queue. #### Initializer ```typescript import { SqsRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsRecommendedAlarmsConfig: SqsRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configApproximateAgeOfOldestMessageAlarm | SqsApproximateAgeOfOldestMessageAlarmConfig | The configuration for the approximate age of oldest message alarm. | | configApproximateNumberOfMessagesNotVisibleAlarm | SqsApproximateNumberOfMessagesNotVisibleAlarmConfig | The configuration for the approximate number of messages not visible alarm. | | configApproximateNumberOfMessagesVisibleAlarm | SqsApproximateNumberOfMessagesVisibleAlarmConfig | The configuration for the approximate number of messages visible alarm. | | configDlqApproximateNumberOfMessagesVisibleAlarm | SqsApproximateNumberOfMessagesVisibleAlarmConfig | The configuration for the approximate number of messages visible alarm for DLQs. | | configNumberOfMessagesSentAlarm | SqsNumberOfMessagesSentAlarmConfig | The configuration for the number of messages sent alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | dlqsGetFullRecommendedAlarms | boolean | Whether to apply the usual recommended alarms to dead letter queues. | | excludeAlarms | SqsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configApproximateAgeOfOldestMessageAlarm`^Required ```typescript public readonly configApproximateAgeOfOldestMessageAlarm: SqsApproximateAgeOfOldestMessageAlarmConfig; ``` - *Type:* SqsApproximateAgeOfOldestMessageAlarmConfig The configuration for the approximate age of oldest message alarm. --- ##### `configApproximateNumberOfMessagesNotVisibleAlarm`^Required ```typescript public readonly configApproximateNumberOfMessagesNotVisibleAlarm: SqsApproximateNumberOfMessagesNotVisibleAlarmConfig; ``` - *Type:* SqsApproximateNumberOfMessagesNotVisibleAlarmConfig The configuration for the approximate number of messages not visible alarm. --- ##### `configApproximateNumberOfMessagesVisibleAlarm`^Required ```typescript public readonly configApproximateNumberOfMessagesVisibleAlarm: SqsApproximateNumberOfMessagesVisibleAlarmConfig; ``` - *Type:* SqsApproximateNumberOfMessagesVisibleAlarmConfig The configuration for the approximate number of messages visible alarm. --- ##### `configDlqApproximateNumberOfMessagesVisibleAlarm`^Optional ```typescript public readonly configDlqApproximateNumberOfMessagesVisibleAlarm: SqsApproximateNumberOfMessagesVisibleAlarmConfig; ``` - *Type:* SqsApproximateNumberOfMessagesVisibleAlarmConfig The configuration for the approximate number of messages visible alarm for DLQs. This is used for dead letter queues only. The threshold is set to 1 by default. --- ##### `configNumberOfMessagesSentAlarm`^Optional ```typescript public readonly configNumberOfMessagesSentAlarm: SqsNumberOfMessagesSentAlarmConfig; ``` - *Type:* SqsNumberOfMessagesSentAlarmConfig The configuration for the number of messages sent alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `dlqsGetFullRecommendedAlarms`^Optional ```typescript public readonly dlqsGetFullRecommendedAlarms: boolean; ``` - *Type:* boolean - *Default:* false Whether to apply the usual recommended alarms to dead letter queues. If true, the dead letter queues will have the same alarms as normal queues. If false, the dead letter queues will only have the ApproximateNumberOfMessagesVisible alarm with a default threshold of 1. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: SqsRecommendedAlarmsMetrics[]; ``` - *Type:* SqsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### SqsRecommendedAlarmsProps Properties for the SqsRecommendedAlarms construct. #### Initializer ```typescript import { SqsRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const sqsRecommendedAlarmsProps: SqsRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configApproximateAgeOfOldestMessageAlarm | SqsApproximateAgeOfOldestMessageAlarmConfig | The configuration for the approximate age of oldest message alarm. | | configApproximateNumberOfMessagesNotVisibleAlarm | SqsApproximateNumberOfMessagesNotVisibleAlarmConfig | The configuration for the approximate number of messages not visible alarm. | | configApproximateNumberOfMessagesVisibleAlarm | SqsApproximateNumberOfMessagesVisibleAlarmConfig | The configuration for the approximate number of messages visible alarm. | | configDlqApproximateNumberOfMessagesVisibleAlarm | SqsApproximateNumberOfMessagesVisibleAlarmConfig | The configuration for the approximate number of messages visible alarm for DLQs. | | configNumberOfMessagesSentAlarm | SqsNumberOfMessagesSentAlarmConfig | The configuration for the number of messages sent alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | dlqsGetFullRecommendedAlarms | boolean | Whether to apply the usual recommended alarms to dead letter queues. | | excludeAlarms | SqsRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | queue | aws-cdk-lib.aws_sqs.IQueue | The SQS queue for which to create the alarms. | --- ##### `configApproximateAgeOfOldestMessageAlarm`^Required ```typescript public readonly configApproximateAgeOfOldestMessageAlarm: SqsApproximateAgeOfOldestMessageAlarmConfig; ``` - *Type:* SqsApproximateAgeOfOldestMessageAlarmConfig The configuration for the approximate age of oldest message alarm. --- ##### `configApproximateNumberOfMessagesNotVisibleAlarm`^Required ```typescript public readonly configApproximateNumberOfMessagesNotVisibleAlarm: SqsApproximateNumberOfMessagesNotVisibleAlarmConfig; ``` - *Type:* SqsApproximateNumberOfMessagesNotVisibleAlarmConfig The configuration for the approximate number of messages not visible alarm. --- ##### `configApproximateNumberOfMessagesVisibleAlarm`^Required ```typescript public readonly configApproximateNumberOfMessagesVisibleAlarm: SqsApproximateNumberOfMessagesVisibleAlarmConfig; ``` - *Type:* SqsApproximateNumberOfMessagesVisibleAlarmConfig The configuration for the approximate number of messages visible alarm. --- ##### `configDlqApproximateNumberOfMessagesVisibleAlarm`^Optional ```typescript public readonly configDlqApproximateNumberOfMessagesVisibleAlarm: SqsApproximateNumberOfMessagesVisibleAlarmConfig; ``` - *Type:* SqsApproximateNumberOfMessagesVisibleAlarmConfig The configuration for the approximate number of messages visible alarm for DLQs. This is used for dead letter queues only. The threshold is set to 1 by default. --- ##### `configNumberOfMessagesSentAlarm`^Optional ```typescript public readonly configNumberOfMessagesSentAlarm: SqsNumberOfMessagesSentAlarmConfig; ``` - *Type:* SqsNumberOfMessagesSentAlarmConfig The configuration for the number of messages sent alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `dlqsGetFullRecommendedAlarms`^Optional ```typescript public readonly dlqsGetFullRecommendedAlarms: boolean; ``` - *Type:* boolean - *Default:* false Whether to apply the usual recommended alarms to dead letter queues. If true, the dead letter queues will have the same alarms as normal queues. If false, the dead letter queues will only have the ApproximateNumberOfMessagesVisible alarm with a default threshold of 1. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: SqsRecommendedAlarmsMetrics[]; ``` - *Type:* SqsRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `queue`^Required ```typescript public readonly queue: IQueue; ``` - *Type:* aws-cdk-lib.aws_sqs.IQueue The SQS queue for which to create the alarms. --- ### VpnAlarmBaseConfig The common optional configuration for the alarms. #### Initializer ```typescript import { VpnAlarmBaseConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const vpnAlarmBaseConfig: VpnAlarmBaseConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(5) The period over which the specified statistic is applied. --- ### VpnConnectionAlarmProps The common properties for the VpnConnection alarms. #### Initializer ```typescript import { VpnConnectionAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const vpnConnectionAlarmProps: VpnConnectionAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | vpnConnection | aws-cdk-lib.aws_ec2.CfnVPNConnection | The VpnConnection to monitor. | --- ##### `vpnConnection`^Required ```typescript public readonly vpnConnection: CfnVPNConnection; ``` - *Type:* aws-cdk-lib.aws_ec2.CfnVPNConnection The VpnConnection to monitor. --- ### VpnConnectionRecommendedAlarmsConfig Configurations for the recommended alarms for an VPN Service. Default actions are overridden by the actions specified in the individual alarm configurations. #### Initializer ```typescript import { VpnConnectionRecommendedAlarmsConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const vpnConnectionRecommendedAlarmsConfig: VpnConnectionRecommendedAlarmsConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configTunnelStateAlarm | VpnTunnelStateAlarmConfig | The configuration for the TunnelState alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | VpnRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | --- ##### `configTunnelStateAlarm`^Optional ```typescript public readonly configTunnelStateAlarm: VpnTunnelStateAlarmConfig; ``` - *Type:* VpnTunnelStateAlarmConfig The configuration for the TunnelState alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: VpnRecommendedAlarmsMetrics[]; ``` - *Type:* VpnRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ### VpnConnectionRecommendedAlarmsProps Properties for the VpnConnectionRecommendedAlarms construct. #### Initializer ```typescript import { VpnConnectionRecommendedAlarmsProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const vpnConnectionRecommendedAlarmsProps: VpnConnectionRecommendedAlarmsProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | configTunnelStateAlarm | VpnTunnelStateAlarmConfig | The configuration for the TunnelState alarm. | | defaultAlarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm is triggered. | | defaultInsufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm has insufficient data. | | defaultOkAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The default action to take when an alarm enters the ok state. | | excludeAlarms | VpnRecommendedAlarmsMetrics[] | Alarm metrics to exclude from the recommended alarms. | | excludeResources | string[] | The resources to exclude from the recommended alarms. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | vpnConnection | aws-cdk-lib.aws_ec2.CfnVPNConnection | The VpnConnection to monitor. | --- ##### `configTunnelStateAlarm`^Optional ```typescript public readonly configTunnelStateAlarm: VpnTunnelStateAlarmConfig; ``` - *Type:* VpnTunnelStateAlarmConfig The configuration for the TunnelState alarm. --- ##### `defaultAlarmAction`^Optional ```typescript public readonly defaultAlarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm is triggered. --- ##### `defaultInsufficientDataAction`^Optional ```typescript public readonly defaultInsufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm has insufficient data. --- ##### `defaultOkAction`^Optional ```typescript public readonly defaultOkAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The default action to take when an alarm enters the ok state. --- ##### `excludeAlarms`^Optional ```typescript public readonly excludeAlarms: VpnRecommendedAlarmsMetrics[]; ``` - *Type:* VpnRecommendedAlarmsMetrics[] - *Default:* None Alarm metrics to exclude from the recommended alarms. --- ##### `excludeResources`^Optional ```typescript public readonly excludeResources: string[]; ``` - *Type:* string[] The resources to exclude from the recommended alarms. Use a resources id to exclude a specific resource. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `vpnConnection`^Required ```typescript public readonly vpnConnection: CfnVPNConnection; ``` - *Type:* aws-cdk-lib.aws_ec2.CfnVPNConnection The VpnConnection to monitor. --- ### VpnConnectionTunnelStateAlarmProps The properties for the VpnConnectionTunnelStateAlarm construct. #### Initializer ```typescript import { VpnConnectionTunnelStateAlarmProps } from '@renovosolutions/cdk-library-cloudwatch-alarms' const vpnConnectionTunnelStateAlarmProps: VpnConnectionTunnelStateAlarmProps = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | vpnConnection | aws-cdk-lib.aws_ec2.CfnVPNConnection | The VpnConnection to monitor. | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | A value less than 1 indicates that at least one tunnel is in DOWN state. | --- ##### `vpnConnection`^Required ```typescript public readonly vpnConnection: CfnVPNConnection; ``` - *Type:* aws-cdk-lib.aws_ec2.CfnVPNConnection The VpnConnection to monitor. --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(5) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect if at least one tunnel is in the DOWN state for this VPN, so that you can troubleshoot the impacted VPN. This alarm will always be in the ALARM state for networks that only have a single tunnel configured. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* vpnConnectionId + ' - TunnelState' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 A value less than 1 indicates that at least one tunnel is in DOWN state. --- ### VpnTunnelStateAlarmConfig Configuration for the TunnelState alarm. #### Initializer ```typescript import { VpnTunnelStateAlarmConfig } from '@renovosolutions/cdk-library-cloudwatch-alarms' const vpnTunnelStateAlarmConfig: VpnTunnelStateAlarmConfig = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | alarmAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm is triggered. | | insufficientDataAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm has insufficient data. | | okAction | aws-cdk-lib.aws_cloudwatch.IAlarmAction | The action to take when an alarm enters the ok state. | | treatMissingData | aws-cdk-lib.aws_cloudwatch.TreatMissingData | How to handle missing data for this alarm. | | period | aws-cdk-lib.Duration | The period over which the specified statistic is applied. | | alarmDescription | string | The description of the alarm. | | alarmName | string | The alarm name. | | datapointsToAlarm | number | The number of data points that must be breaching to trigger the alarm. | | evaluationPeriods | number | The number of periods over which data is compared to the specified threshold. | | threshold | number | A value less than 1 indicates that at least one tunnel is in DOWN state. | --- ##### `alarmAction`^Optional ```typescript public readonly alarmAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm is triggered. --- ##### `insufficientDataAction`^Optional ```typescript public readonly insufficientDataAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm has insufficient data. --- ##### `okAction`^Optional ```typescript public readonly okAction: IAlarmAction; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.IAlarmAction - *Default:* None The action to take when an alarm enters the ok state. --- ##### `treatMissingData`^Optional ```typescript public readonly treatMissingData: TreatMissingData; ``` - *Type:* aws-cdk-lib.aws_cloudwatch.TreatMissingData - *Default:* TreatMissingData.MISSING How to handle missing data for this alarm. --- ##### `period`^Optional ```typescript public readonly period: Duration; ``` - *Type:* aws-cdk-lib.Duration - *Default:* Duration.minutes(5) The period over which the specified statistic is applied. --- ##### `alarmDescription`^Optional ```typescript public readonly alarmDescription: string; ``` - *Type:* string - *Default:* This alarm is used to detect if at least one tunnel is in the DOWN state for this VPN, so that you can troubleshoot the impacted VPN. This alarm will always be in the ALARM state for networks that only have a single tunnel configured. The description of the alarm. --- ##### `alarmName`^Optional ```typescript public readonly alarmName: string; ``` - *Type:* string - *Default:* vpnConnectionId + ' - TunnelState' The alarm name. --- ##### `datapointsToAlarm`^Optional ```typescript public readonly datapointsToAlarm: number; ``` - *Type:* number - *Default:* 3 The number of data points that must be breaching to trigger the alarm. --- ##### `evaluationPeriods`^Optional ```typescript public readonly evaluationPeriods: number; ``` - *Type:* number - *Default:* 3 The number of periods over which data is compared to the specified threshold. --- ##### `threshold`^Optional ```typescript public readonly threshold: number; ``` - *Type:* number - *Default:* 1 A value less than 1 indicates that at least one tunnel is in DOWN state. --- ## Classes ### ApiGatewayRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an ApiGateway api. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ApiGateway) #### Initializers ```typescript import { ApiGatewayRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApiGatewayRecommendedAlarmsAspect(props: ApiGatewayRestApiRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ApiGatewayRestApiRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* ApiGatewayRestApiRecommendedAlarmsConfig --- #### 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 --- ### ApplicationLoadBalancerRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an ApplicationLoadBalancer. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) #### Initializers ```typescript import { ApplicationLoadBalancerRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationLoadBalancerRecommendedAlarmsAspect(props: ApplicationLoadBalancerRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ApplicationLoadBalancerRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* ApplicationLoadBalancerRecommendedAlarmsConfig --- #### 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 --- ### ApplicationTargetGroupRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an ApplicationTargetGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) #### Initializers ```typescript import { ApplicationTargetGroupRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ApplicationTargetGroupRecommendedAlarmsAspect(props: ApplicationTargetGroupRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ApplicationTargetGroupRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* ApplicationTargetGroupRecommendedAlarmsConfig --- #### 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 --- ### AutoScalingRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an EC2 AutoScalingGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#AutoScaling](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#AutoScaling) #### Initializers ```typescript import { AutoScalingRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new AutoScalingRecommendedAlarmsAspect(props: AutoScalingGroupRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | AutoScalingGroupRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* AutoScalingGroupRecommendedAlarmsConfig --- #### 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 --- ### CloudFrontRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an CloudFront Distribution. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#CloudFront](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#CloudFront) #### Initializers ```typescript import { CloudFrontRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new CloudFrontRecommendedAlarmsAspect(props: CloudFrontDistributionRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | CloudFrontDistributionRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* CloudFrontDistributionRecommendedAlarmsConfig --- #### 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 --- ### DmsReplicationInstanceRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for a DMS Replication Instance. > [https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/](https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/) #### Initializers ```typescript import { DmsReplicationInstanceRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationInstanceRecommendedAlarmsAspect(props: DmsReplicationInstanceRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | DmsReplicationInstanceRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* DmsReplicationInstanceRecommendedAlarmsConfig --- #### 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 --- ### DmsReplicationTaskRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for a DMS Replication Task. > [https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/](https://aws.amazon.com/blogs/database/setting-up-amazon-cloudwatch-alarms-for-aws-dms-resources-using-the-aws-cli/) #### Initializers ```typescript import { DmsReplicationTaskRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DmsReplicationTaskRecommendedAlarmsAspect(props?: DmsReplicationTaskRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | DmsReplicationTaskRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Optional - *Type:* DmsReplicationTaskRecommendedAlarmsConfig --- #### 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 --- ### DynamoDbRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an DynamoDb Table. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#DynamoDB](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#DynamoDB) #### Initializers ```typescript import { DynamoDbRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new DynamoDbRecommendedAlarmsAspect(props: DynamoDbTableRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | DynamoDbTableRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* DynamoDbTableRecommendedAlarmsConfig --- #### 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 --- ### Ec2RecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an EC2 Instance. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EC2](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EC2) #### Initializers ```typescript import { Ec2RecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new Ec2RecommendedAlarmsAspect(props?: Ec2InstanceRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | Ec2InstanceRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Optional - *Type:* Ec2InstanceRecommendedAlarmsConfig --- #### 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 --- ### EcsRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an ECS service. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ECS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ECS) #### Initializers ```typescript import { EcsRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EcsRecommendedAlarmsAspect(props: EcsServiceRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | EcsServiceRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* EcsServiceRecommendedAlarmsConfig --- #### 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 --- ### EfsRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an EFS FileSystem. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EFS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#EFS) #### Initializers ```typescript import { EfsRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new EfsRecommendedAlarmsAspect(props?: EfsFileSystemRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | EfsFileSystemRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Optional - *Type:* EfsFileSystemRecommendedAlarmsConfig --- #### 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 --- ### ElastiCacheClusterRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an ElastiCache CfnCacheCluster. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache) #### Initializers ```typescript import { ElastiCacheClusterRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheClusterRecommendedAlarmsAspect(props: ElastiCacheClusterRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ElastiCacheClusterRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* ElastiCacheClusterRecommendedAlarmsConfig --- #### 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 --- ### ElastiCacheReplicationGroupRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an ElastiCache CfnReplicationGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#ElastiCache) #### Initializers ```typescript import { ElastiCacheReplicationGroupRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new ElastiCacheReplicationGroupRecommendedAlarmsAspect(props: ElastiCacheReplicationGroupRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | ElastiCacheReplicationGroupRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* ElastiCacheReplicationGroupRecommendedAlarmsConfig --- #### 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 --- ### LambdaRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect An aspect that applies recommended alarms for Lambda functions. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#Lambda](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#Lambda) #### Initializers ```typescript import { LambdaRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new LambdaRecommendedAlarmsAspect(props: LambdaRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | LambdaRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* LambdaRecommendedAlarmsConfig --- #### 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 --- ### NetworkLoadBalancerRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for a NetworkLoadBalancer. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) #### Initializers ```typescript import { NetworkLoadBalancerRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkLoadBalancerRecommendedAlarmsAspect(props: NetworkLoadBalancerRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | NetworkLoadBalancerRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* NetworkLoadBalancerRecommendedAlarmsConfig --- #### 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 --- ### NetworkTargetGroupRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for a NetworkTargetGroup. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/elb-metricscollected.html) #### Initializers ```typescript import { NetworkTargetGroupRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new NetworkTargetGroupRecommendedAlarmsAspect(props: NetworkTargetGroupRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | NetworkTargetGroupRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* NetworkTargetGroupRecommendedAlarmsConfig --- #### 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 --- ### RdsAuroraRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect An aspect that applies recommended alarms for RDS clusters. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS) #### Initializers ```typescript import { RdsAuroraRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsAuroraRecommendedAlarmsAspect(props: RdsAuroraRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | RdsAuroraRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* RdsAuroraRecommendedAlarmsConfig --- #### 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 --- ### RdsInstanceRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect An aspect that applies recommended alarms for RDS database instances. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#RDS) #### Initializers ```typescript import { RdsInstanceRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new RdsInstanceRecommendedAlarmsAspect(props: RdsInstanceRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | RdsInstanceRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* RdsInstanceRecommendedAlarmsConfig --- #### 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 --- ### S3RecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an S3 bucket. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#S3](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#S3) #### Initializers ```typescript import { S3RecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new S3RecommendedAlarmsAspect(props?: S3RecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | S3RecommendedAlarmsConfig | *No description.* | --- ##### `props`^Optional - *Type:* S3RecommendedAlarmsConfig --- #### 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 --- ### SfRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the alarms for an StepFunctions StateMachine. #### Initializers ```typescript import { SfRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SfRecommendedAlarmsAspect(props: SfStateMachineRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SfStateMachineRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* SfStateMachineRecommendedAlarmsConfig --- #### 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 --- ### SnsRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect An aspect that applies recommended alarms to SNS topics. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SNS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SNS) #### Initializers ```typescript import { SnsRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SnsRecommendedAlarmsAspect(props: SnsRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SnsRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* SnsRecommendedAlarmsConfig --- #### 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 --- ### SqsRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configured the recommended alarms for an SQS queue. Requires defining thresholds for some alarms. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SQS](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#SQS) #### Initializers ```typescript import { SqsRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new SqsRecommendedAlarmsAspect(props: SqsRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | SqsRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Required - *Type:* SqsRecommendedAlarmsConfig --- #### 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 --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | deadLetterQueues | string[] | A list of dead letter queues discovered in the scope. | | deadLetterQueuesDiscovered | boolean | A flag to indicate whether dead letter queues have been discovered. | --- ##### `deadLetterQueues`^Required ```typescript public readonly deadLetterQueues: string[]; ``` - *Type:* string[] A list of dead letter queues discovered in the scope. We exclude these from the recommended alarms because they don't make sense. --- ##### `deadLetterQueuesDiscovered`^Required ```typescript public readonly deadLetterQueuesDiscovered: boolean; ``` - *Type:* boolean A flag to indicate whether dead letter queues have been discovered. This is used to prevent running the discovery logic on every call to `visit`. --- ### VpnRecommendedAlarmsAspect - *Implements:* aws-cdk-lib.IAspect Configures the recommended alarms for an VpnConnection. > [https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#VPN](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Best_Practice_Recommended_Alarms_AWS_Services.html#VPN) #### Initializers ```typescript import { VpnRecommendedAlarmsAspect } from '@renovosolutions/cdk-library-cloudwatch-alarms' new VpnRecommendedAlarmsAspect(props?: VpnConnectionRecommendedAlarmsConfig) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | props | VpnConnectionRecommendedAlarmsConfig | *No description.* | --- ##### `props`^Optional - *Type:* VpnConnectionRecommendedAlarmsConfig --- #### 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 --- ## Enums ### ApiGatewayRecommendedAlarmsMetrics The recommended metrics for ApiGateway alarms. #### Members | **Name** | **Description** | | --- | --- | | ERROR_4XX | The number of client-side errors captured in a given period. | | ERROR_5XX | The number of server-side errors captured in a given period. | | LATENCY | The time (milliseconds) between when API Gateway receives a request from a client and when it returns a response to the client. | | LATENCY_ANOMALY | Anomaly detection on the Latency metric. | | COUNT_ANOMALY | Anomaly detection on the Count metric. | | INTEGRATION_LATENCY_ANOMALY | Anomaly detection on the IntegrationLatency metric. | --- ##### `ERROR_4XX` The number of client-side errors captured in a given period. --- ##### `ERROR_5XX` The number of server-side errors captured in a given period. --- ##### `LATENCY` The time (milliseconds) between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead. --- ##### `LATENCY_ANOMALY` Anomaly detection on the Latency metric. Detects drift in total request latency (API Gateway overhead + backend integration) without requiring a static threshold. --- ##### `COUNT_ANOMALY` Anomaly detection on the Count metric. Detects unexpected drops (or spikes) in traffic volume for low-traffic APIs where a static `LESS_THAN_THRESHOLD` value is hard to pick. --- ##### `INTEGRATION_LATENCY_ANOMALY` Anomaly detection on the IntegrationLatency metric. Detects drift in backend latency independently of overall request latency. No static counterpart exists in this library. --- ### ApplicationLoadBalancerRecommendedAlarmsMetrics The recommended metrics for ApplicationLoadBalancer alarms. #### Members | **Name** | **Description** | | --- | --- | | REJECTED_CONNECTION_COUNT | The number of connection requests that were rejected because the load balancer had reached its maximum connections. | | HTTP_CODE_ELB_4XX_COUNT | The number of HTTP 4XX client error codes generated by the load balancer. | | HTTP_CODE_ELB_5XX_COUNT | The number of HTTP 5XX server error codes generated by the load balancer. | | HTTP_CODE_TARGET_5XX_COUNT | The number of HTTP 5XX server error codes generated by the targets. | --- ##### `REJECTED_CONNECTION_COUNT` The number of connection requests that were rejected because the load balancer had reached its maximum connections. --- ##### `HTTP_CODE_ELB_4XX_COUNT` The number of HTTP 4XX client error codes generated by the load balancer. --- ##### `HTTP_CODE_ELB_5XX_COUNT` The number of HTTP 5XX server error codes generated by the load balancer. --- ##### `HTTP_CODE_TARGET_5XX_COUNT` The number of HTTP 5XX server error codes generated by the targets. --- ### ApplicationTargetGroupRecommendedAlarmsMetrics The recommended metrics for ApplicationTargetGroup alarms. #### Members | **Name** | **Description** | | --- | --- | | HEALTHY_HOST_COUNT | The number of healthy targets in the target group. | | UNHEALTHY_HOST_COUNT | The number of unhealthy targets in the target group. | --- ##### `HEALTHY_HOST_COUNT` The number of healthy targets in the target group. --- ##### `UNHEALTHY_HOST_COUNT` The number of unhealthy targets in the target group. --- ### AutoScalingRecommendedAlarmsMetrics The recommended metrics for EC2 AutoScaling alarms. #### Members | **Name** | **Description** | | --- | --- | | GROUP_IN_SERVICE_CAPACITY | The number of capacity units that are running as part of the Auto Scaling group. | --- ##### `GROUP_IN_SERVICE_CAPACITY` The number of capacity units that are running as part of the Auto Scaling group. --- ### CloudFrontRecommendedAlarmsMetrics The recommended metrics for CloudFront alarms. #### Members | **Name** | **Description** | | --- | --- | | ERROR_RATE_5XX | The percentage of all viewer requests for which the response's HTTP status code is 5xx. | | ORIGIN_LATENCY | The total time spent from when CloudFront receives a request to when it starts providing a response to the network (not the viewer), for requests that are served from the origin, not the CloudFront cache. | | FUNCTION_VALIDATION_ERRORS | The number of validation errors produced by the function in a given time period. | | FUNCTION_EXECUTION_ERRORS | The number of execution errors that occurred in a given time period. | | FUNCTION_THROTTLES | The number of times that the function was throttled in a given time period. | --- ##### `ERROR_RATE_5XX` The percentage of all viewer requests for which the response's HTTP status code is 5xx. --- ##### `ORIGIN_LATENCY` The total time spent from when CloudFront receives a request to when it starts providing a response to the network (not the viewer), for requests that are served from the origin, not the CloudFront cache. This is also known as first byte latency, or time-to-first-byte. --- ##### `FUNCTION_VALIDATION_ERRORS` The number of validation errors produced by the function in a given time period. Validation errors occur when the function runs successfully but returns invalid data (an invalid {@link https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/functions-event-structure.html event object}). --- ##### `FUNCTION_EXECUTION_ERRORS` The number of execution errors that occurred in a given time period. Execution errors occur when the function fails to complete successfully. --- ##### `FUNCTION_THROTTLES` The number of times that the function was throttled in a given time period. Functions can be throttled for the following reasons: - The function continuously exceeds the maximum time allowed for execution - The function results in compilation errors - There is an unusually high number of requests per second --- ### DmsReplicationInstanceRecommendedAlarmsMetrics The recommended metrics for DMS Replication Instance alarms. #### Members | **Name** | **Description** | | --- | --- | | CPU_UTILIZATION | The percentage of allocated vCPU (virtual CPU) currently in use on the instance. | | FREEABLE_MEMORY | The amount in bytes of available random access memory. | | FREE_STORAGE_SPACE | The amount in bytes of available storage space. | | WRITE_IOPS | The average number of disk write I/O operations per second. | | SWAP_USAGE | The amount in bytes of swap space used on the replication instance. | --- ##### `CPU_UTILIZATION` The percentage of allocated vCPU (virtual CPU) currently in use on the instance. --- ##### `FREEABLE_MEMORY` The amount in bytes of available random access memory. --- ##### `FREE_STORAGE_SPACE` The amount in bytes of available storage space. --- ##### `WRITE_IOPS` The average number of disk write I/O operations per second. --- ##### `SWAP_USAGE` The amount in bytes of swap space used on the replication instance. --- ### DmsReplicationTaskMigrationType DMS Replication Task migration types. These are the valid migration types for AWS DMS Replication Tasks. #### Members | **Name** | **Description** | | --- | --- | | FULL_LOAD | Full load migration - copies all existing data from the source to the target. | | CDC | Change Data Capture (CDC) migration - captures ongoing changes from the source. | | FULL_LOAD_AND_CDC | Full load and CDC migration - performs initial full load then captures ongoing changes. | --- ##### `FULL_LOAD` Full load migration - copies all existing data from the source to the target. --- ##### `CDC` Change Data Capture (CDC) migration - captures ongoing changes from the source. --- ##### `FULL_LOAD_AND_CDC` Full load and CDC migration - performs initial full load then captures ongoing changes. --- ### DmsReplicationTaskRecommendedAlarmsMetrics The recommended metrics for DMS Replication Task alarms. #### Members | **Name** | **Description** | | --- | --- | | CDC_LATENCY_SOURCE | The gap, in seconds, between the last event captured from the source endpoint and current system time. | | CDC_LATENCY_TARGET | The gap, in seconds, between a change that was committed to the source and the same change committed to the target. | --- ##### `CDC_LATENCY_SOURCE` The gap, in seconds, between the last event captured from the source endpoint and current system time. --- ##### `CDC_LATENCY_TARGET` The gap, in seconds, between a change that was committed to the source and the same change committed to the target. --- ### DynamoDbRecommendedAlarmsMetrics The recommended metrics for DynamoDb alarms. #### Members | **Name** | **Description** | | --- | --- | | READ_THROTTLE_EVENTS | Requests to DynamoDB that exceed the provisioned read capacity units for a table or a global secondary index. | | SYSTEM_ERRORS | The requests to DynamoDB or Amazon DynamoDB Streams that generate an HTTP 500 status code during the specified time period. | | WRITE_THROTTLE_EVENTS | Requests to DynamoDB that exceed the provisioned write capacity units for a table or a global secondary index. | | AGE_OF_OLDEST_UNREPLICATED_RECORD | The elapsed time since a record yet to be replicated to the Kinesis data stream first appeared in the DynamoDB table. | | FAILED_TO_REPLICATE_RECORD_COUNT | The number of records that DynamoDB failed to replicate to your Kinesis data stream. | | THROTTLED_PUT_RECORD_COUNT | The number of records that were throttled by your Kinesis data stream due to insufficient Kinesis Data Streams capacity. | --- ##### `READ_THROTTLE_EVENTS` Requests to DynamoDB that exceed the provisioned read capacity units for a table or a global secondary index. --- ##### `SYSTEM_ERRORS` The requests to DynamoDB or Amazon DynamoDB Streams that generate an HTTP 500 status code during the specified time period. An HTTP 500 usually indicates an internal service error. --- ##### `WRITE_THROTTLE_EVENTS` Requests to DynamoDB that exceed the provisioned write capacity units for a table or a global secondary index. --- ##### `AGE_OF_OLDEST_UNREPLICATED_RECORD` The elapsed time since a record yet to be replicated to the Kinesis data stream first appeared in the DynamoDB table. --- ##### `FAILED_TO_REPLICATE_RECORD_COUNT` The number of records that DynamoDB failed to replicate to your Kinesis data stream. --- ##### `THROTTLED_PUT_RECORD_COUNT` The number of records that were throttled by your Kinesis data stream due to insufficient Kinesis Data Streams capacity. --- ### Ec2RecommendedAlarmsMetrics The recommended metrics for EC2 alarms. #### Members | **Name** | **Description** | | --- | --- | | CPU_UTILIZATION | The percentage of physical CPU time that Amazon EC2 uses to run the EC2 instance, which includes time spent to run both the user code and the Amazon EC2 code. | | STATUS_CHECK_FAILED | Reports whether the instance has passed all status checks in the last minute. | --- ##### `CPU_UTILIZATION` The percentage of physical CPU time that Amazon EC2 uses to run the EC2 instance, which includes time spent to run both the user code and the Amazon EC2 code. --- ##### `STATUS_CHECK_FAILED` Reports whether the instance has passed all status checks in the last minute. This metric can be either 0 (passed) or 1 (failed). By default, this metric is available at a 1-minute frequency at no charge. --- ### EcsRecommendedAlarmsMetrics The recommended metrics for ECS alarms. #### Members | **Name** | **Description** | | --- | --- | | CPU_UTILIZATION | The percentage of CPU units that is used by the cluster or service. | | MEMORY_UTILIZATION | The percentage of memory in use by the cluster or service. | | EPHEMERAL_STORAGE_UTILIZED | The ephemeral storage in GB that is used by the cluster or service. | | RUNNING_TASK_COUNT | The number of tasks in your services that are in the RUNNING state. | --- ##### `CPU_UTILIZATION` The percentage of CPU units that is used by the cluster or service. --- ##### `MEMORY_UTILIZATION` The percentage of memory in use by the cluster or service. --- ##### `EPHEMERAL_STORAGE_UTILIZED` The ephemeral storage in GB that is used by the cluster or service. --- ##### `RUNNING_TASK_COUNT` The number of tasks in your services that are in the RUNNING state. --- ### EfsRecommendedAlarmsMetrics The recommended metrics for EFS alarms. #### Members | **Name** | **Description** | | --- | --- | | PERCENT_IO_LIMIT | Percentage of how close a file system is to reaching the I/O limit of the General Purpose performance mode. | | BURST_CREDIT_BALANCE | The number of burst credits that a file system has. | --- ##### `PERCENT_IO_LIMIT` Percentage of how close a file system is to reaching the I/O limit of the General Purpose performance mode. --- ##### `BURST_CREDIT_BALANCE` The number of burst credits that a file system has. Burst credits allow a file system to burst to throughput levels above a file system's baseline level for periods of time. --- ### ElastiCacheRecommendedAlarmsMetrics The recommended metrics for ElastiCache alarms. #### Members | **Name** | **Description** | | --- | --- | | DATABASE_MEMORY_USAGE_PERCENTAGE | Percentage of the memory for the cluster that is in use. | | ENGINE_CPU_UTILIZATION | Provides CPU utilization of the Valkey or Redis OSS engine thread. | | REPLICATION_LAG | It represents how far behind, in seconds, the replica is in applying changes from the primary node. | --- ##### `DATABASE_MEMORY_USAGE_PERCENTAGE` Percentage of the memory for the cluster that is in use. --- ##### `ENGINE_CPU_UTILIZATION` Provides CPU utilization of the Valkey or Redis OSS engine thread. Because Valkey and Redis OSS are single-threaded, you can use this metric to analyze the load of the process itself. The `EngineCPUUtilization` metric provides a more precise visibility of the process. You can use it in conjunction with the `CPUUtilization` metric. `CPUUtilization` exposes CPU utilization for the server instance as a whole, including other operating system and management processes. For larger node types with four vCPUs or more, use the EngineCPUUtilization metric to monitor and set thresholds for scaling. --- ##### `REPLICATION_LAG` It represents how far behind, in seconds, the replica is in applying changes from the primary node. For Valkey 7.2 and onwards, and Redis OSS engine version 5.0.6 onwards, the lag can be measured in milliseconds. --- ### LambdaRecommendedAlarmsMetrics The recommended metrics for Lambda alarms. #### Members | **Name** | **Description** | | --- | --- | | ERRORS | Errors include the exceptions thrown by the code as well as exceptions thrown by the Lambda runtime. | | THROTTLES | Throttles occur when there is no concurrency available for scale up. | | DURATION | Duration is the time taken for the function to process an event. | | CONCURRENT_EXECUTIONS | ConcurrentExecutions is the number of concurrent executions of the function. | --- ##### `ERRORS` Errors include the exceptions thrown by the code as well as exceptions thrown by the Lambda runtime. --- ##### `THROTTLES` Throttles occur when there is no concurrency available for scale up. --- ##### `DURATION` Duration is the time taken for the function to process an event. --- ##### `CONCURRENT_EXECUTIONS` ConcurrentExecutions is the number of concurrent executions of the function. --- ### NetworkLoadBalancerRecommendedAlarmsMetrics The recommended metrics for NetworkLoadBalancer alarms. #### Members | **Name** | **Description** | | --- | --- | | TCP_ELB_RESET_COUNT | The number of reset (RST) packets sent from the load balancer. | | TCP_TARGET_RESET_COUNT | The number of reset (RST) packets generated by the targets. | --- ##### `TCP_ELB_RESET_COUNT` The number of reset (RST) packets sent from the load balancer. --- ##### `TCP_TARGET_RESET_COUNT` The number of reset (RST) packets generated by the targets. --- ### NetworkTargetGroupRecommendedAlarmsMetrics The recommended metrics for NetworkTargetGroup alarms. #### Members | **Name** | **Description** | | --- | --- | | HEALTHY_HOST_COUNT | The number of healthy targets in the target group. | | UNHEALTHY_HOST_COUNT | The number of unhealthy targets in the target group. | --- ##### `HEALTHY_HOST_COUNT` The number of healthy targets in the target group. --- ##### `UNHEALTHY_HOST_COUNT` The number of unhealthy targets in the target group. --- ### PrivateLinkEndpointsRecommendedAlarmsMetrics The recommended metrics for PrivateLink Endpoints alarms. #### Members | **Name** | **Description** | | --- | --- | | PACKETS_DROPPED | Percentage of how close a file system is to reaching the I/O limit of the General Purpose performance mode. | --- ##### `PACKETS_DROPPED` Percentage of how close a file system is to reaching the I/O limit of the General Purpose performance mode. --- ### PrivateLinkServicesRecommendedAlarmsMetrics The recommended metrics for PrivateLink Services alarms. #### Members | **Name** | **Description** | | --- | --- | | RST_PACKETS_SENT | The number of RST packets sent to endpoints by the endpoint service. | --- ##### `RST_PACKETS_SENT` The number of RST packets sent to endpoints by the endpoint service. Increasing values could indicate that there are unhealthy targets. --- ### RdsRecommendedAlarmsMetrics The recommended metrics for RDS alarms. #### Members | **Name** | **Description** | | --- | --- | | INSTANCE_CPU_UTILIZATION | The percentage of CPU utilization for an RDS instance. | | INSTANCE_DATABASE_CONNECTIONS | The number of client network connections to the database instance. | | INSTANCE_FREEABLE_MEMORY | The amount of available memory (RAM) on the RDS instance. | | INSTANCE_FREE_LOCAL_STORAGE | The amount of available local storage space for an Aurora instance used for temporary files. | | INSTANCE_FREE_STORAGE_SPACE | The amount of available storage space for an Aurora instance. | | INSTANCE_READ_LATENCY | The average amount of time taken per disk read I/O operation. | | INSTANCE_WRITE_LATENCY | The average amount of time taken per disk write I/O operation. | | INSTANCE_DB_LOAD | The average active sessions (AAS) for the DB instance which shows how many sessions are concurrently active on the database. | | AURORA_VOLUME_BYTES_LEFT_TOTAL | The remaining available space for the cluster volume. | | AURORA_BIN_LOG_REPLICATION_LAG | The amount of time that a binary log replica DB cluster running on Aurora MySQL lags behind the binary log replication source. | | AURORA_VOLUME_BYTES_USED | The amount of storage used by the Aurora cluster volume. | --- ##### `INSTANCE_CPU_UTILIZATION` The percentage of CPU utilization for an RDS instance. --- ##### `INSTANCE_DATABASE_CONNECTIONS` The number of client network connections to the database instance. --- ##### `INSTANCE_FREEABLE_MEMORY` The amount of available memory (RAM) on the RDS instance. --- ##### `INSTANCE_FREE_LOCAL_STORAGE` The amount of available local storage space for an Aurora instance used for temporary files. --- ##### `INSTANCE_FREE_STORAGE_SPACE` The amount of available storage space for an Aurora instance. --- ##### `INSTANCE_READ_LATENCY` The average amount of time taken per disk read I/O operation. --- ##### `INSTANCE_WRITE_LATENCY` The average amount of time taken per disk write I/O operation. --- ##### `INSTANCE_DB_LOAD` The average active sessions (AAS) for the DB instance which shows how many sessions are concurrently active on the database. --- ##### `AURORA_VOLUME_BYTES_LEFT_TOTAL` The remaining available space for the cluster volume. --- ##### `AURORA_BIN_LOG_REPLICATION_LAG` The amount of time that a binary log replica DB cluster running on Aurora MySQL lags behind the binary log replication source. --- ##### `AURORA_VOLUME_BYTES_USED` The amount of storage used by the Aurora cluster volume. --- ### S3RecommendedAlarmsMetrics The recommended metrics for S3 bucket alarms. #### Members | **Name** | **Description** | | --- | --- | | ERRORS_4XX | 4xxErrors are errors (4xx error codes) that are made in response to client requests. | | ERRORS_5XX | 5xxErrors are server errors (5xx error codes) that are made in response to client requests. | --- ##### `ERRORS_4XX` 4xxErrors are errors (4xx error codes) that are made in response to client requests. --- ##### `ERRORS_5XX` 5xxErrors are server errors (5xx error codes) that are made in response to client requests. --- ### SfRecommendedAlarmsMetrics The recommended metrics for StepFunctions alarms. #### Members | **Name** | **Description** | | --- | --- | | EXECUTION_TIME | Interval, in milliseconds, between the time the execution starts and the time it closes. | | EXECUTION_THROTTLED | Number of StateEntered events and retries that have been throttled. | | EXECUTIONS_FAILED | Number of failed executions. | | EXECUTIONS_TIMED_OUT | Number of executions that time out for any reason. | --- ##### `EXECUTION_TIME` Interval, in milliseconds, between the time the execution starts and the time it closes. --- ##### `EXECUTION_THROTTLED` Number of StateEntered events and retries that have been throttled. This is related to StateTransition throttling. For more information, see Quotas related to state throttling. --- ##### `EXECUTIONS_FAILED` Number of failed executions. --- ##### `EXECUTIONS_TIMED_OUT` Number of executions that time out for any reason. --- ### SnsRecommendedAlarmsMetrics The recommended metrics for SNS topic alarms. #### Members | **Name** | **Description** | | --- | --- | | NUMBER_OF_MESSAGES_PUBLISHED | The number of messages published to the topic. | | NUMBER_OF_NOTIFICATIONS_DELIVERED | The number of notifications delivered. | | NUMBER_OF_NOTIFICATIONS_FAILED | The number of notifications failed. | | NUMBER_OF_NOTIFICATIONS_FILTERED_OUT_INVALID_ATTRIBUTES | The number of notifications filtered out due to invalid attributes. | | NUMBER_OF_NOTIFICATIONS_FILTERED_OUT_INVALID_MESSAGE_BODY | The number of notifications filtered out due to invalid message body. | | NUMBER_OF_NOTIFICATIONS_REDRIVEN_TO_DLQ | The number of notifications redriven to the dead-letter queue. | | NUMBER_OF_NOTIFICATIONS_FAILED_TO_REDRIVE_TO_DLQ | The number of notifications failed to redrive to the dead-letter queue. | --- ##### `NUMBER_OF_MESSAGES_PUBLISHED` The number of messages published to the topic. --- ##### `NUMBER_OF_NOTIFICATIONS_DELIVERED` The number of notifications delivered. --- ##### `NUMBER_OF_NOTIFICATIONS_FAILED` The number of notifications failed. --- ##### `NUMBER_OF_NOTIFICATIONS_FILTERED_OUT_INVALID_ATTRIBUTES` The number of notifications filtered out due to invalid attributes. --- ##### `NUMBER_OF_NOTIFICATIONS_FILTERED_OUT_INVALID_MESSAGE_BODY` The number of notifications filtered out due to invalid message body. --- ##### `NUMBER_OF_NOTIFICATIONS_REDRIVEN_TO_DLQ` The number of notifications redriven to the dead-letter queue. --- ##### `NUMBER_OF_NOTIFICATIONS_FAILED_TO_REDRIVE_TO_DLQ` The number of notifications failed to redrive to the dead-letter queue. --- ### SqsRecommendedAlarmsMetrics The recommended metrics for SQS queue alarms. #### Members | **Name** | **Description** | | --- | --- | | APPROXIMATE_AGE_OF_OLDEST_MESSAGE | *No description.* | | APPROXIMATE_NUMBER_OF_MESSAGES_NOT_VISIBLE | *No description.* | | APPROXIMATE_NUMBER_OF_MESSAGES_VISIBLE | *No description.* | | NUMBER_OF_MESSAGES_SENT | *No description.* | --- ##### `APPROXIMATE_AGE_OF_OLDEST_MESSAGE` --- ##### `APPROXIMATE_NUMBER_OF_MESSAGES_NOT_VISIBLE` --- ##### `APPROXIMATE_NUMBER_OF_MESSAGES_VISIBLE` --- ##### `NUMBER_OF_MESSAGES_SENT` --- ### VpnRecommendedAlarmsMetrics The recommended metrics for VPN alarms. #### Members | **Name** | **Description** | | --- | --- | | TUNNEL_STATE | Percentage of how close a file system is to reaching the I/O limit of the General Purpose performance mode. | --- ##### `TUNNEL_STATE` Percentage of how close a file system is to reaching the I/O limit of the General Purpose performance mode. ---