class CfnCompositeAlarmPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.CloudWatch.Mixins.CfnCompositeAlarmPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscloudwatch/mixins#CfnCompositeAlarmPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.cloudwatch.mixins.CfnCompositeAlarmPropsMixin
Python	aws_cdk.mixins_preview.aws_cloudwatch.mixins.CfnCompositeAlarmPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_cloudwatch » mixins » CfnCompositeAlarmPropsMixin

Implements IMixin

Extends Mixin

The AWS::CloudWatch::CompositeAlarm type creates or updates a composite alarm.

When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as cloudwatch_mixins } from '@aws-cdk/mixins-preview/aws-cloudwatch';
const cfnCompositeAlarmPropsMixin = new cloudwatch_mixins.CfnCompositeAlarmPropsMixin({
  actionsEnabled: false,
  actionsSuppressor: 'actionsSuppressor',
  actionsSuppressorExtensionPeriod: 123,
  actionsSuppressorWaitPeriod: 123,
  alarmActions: ['alarmActions'],
  alarmDescription: 'alarmDescription',
  alarmName: 'alarmName',
  alarmRule: 'alarmRule',
  insufficientDataActions: ['insufficientDataActions'],
  okActions: ['okActions'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnCompositeAlarmPropsMixin(props: CfnCompositeAlarmMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnCompositeAlarmMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::CloudWatch::CompositeAlarm.

Properties

Name	Type	Description
props	CfnCompositeAlarmMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnCompositeAlarmMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.