class CfnAlarmPropsMixin

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

Implements IMixin

Extends Mixin

The AWS::CloudWatch::Alarm type specifies an alarm and associates it with the specified metric or metric math expression.

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.

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-alarm.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 cfnAlarmPropsMixin = new cloudwatch_mixins.CfnAlarmPropsMixin({
  actionsEnabled: false,
  alarmActions: ['alarmActions'],
  alarmDescription: 'alarmDescription',
  alarmName: 'alarmName',
  comparisonOperator: 'comparisonOperator',
  datapointsToAlarm: 123,
  dimensions: [{
    name: 'name',
    value: 'value',
  }],
  evaluateLowSampleCountPercentile: 'evaluateLowSampleCountPercentile',
  evaluationPeriods: 123,
  extendedStatistic: 'extendedStatistic',
  insufficientDataActions: ['insufficientDataActions'],
  metricName: 'metricName',
  metrics: [{
    accountId: 'accountId',
    expression: 'expression',
    id: 'id',
    label: 'label',
    metricStat: {
      metric: {
        dimensions: [{
          name: 'name',
          value: 'value',
        }],
        metricName: 'metricName',
        namespace: 'namespace',
      },
      period: 123,
      stat: 'stat',
      unit: 'unit',
    },
    period: 123,
    returnData: false,
  }],
  namespace: 'namespace',
  okActions: ['okActions'],
  period: 123,
  statistic: 'statistic',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  threshold: 123,
  thresholdMetricId: 'thresholdMetricId',
  treatMissingData: 'treatMissingData',
  unit: 'unit',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnAlarmPropsMixin(props: CfnAlarmMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

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

Properties

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

---

props

Type: CfnAlarmMixinProps

---

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.