class CfnAlarmModelPropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.IoTEvents.CfnAlarmModelPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsiotevents#CfnAlarmModelPropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.iotevents.CfnAlarmModelPropsMixin
Python	aws_cdk.cfn_property_mixins.aws_iotevents.CfnAlarmModelPropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_iotevents » CfnAlarmModelPropsMixin

Implements IMixin

Extends Mixin

Represents an alarm model to monitor an AWS IoT Events input attribute.

You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotevents as iotevents } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnAlarmModelPropsMixin = new iotevents.CfnAlarmModelPropsMixin({
  alarmCapabilities: {
    acknowledgeFlow: {
      enabled: false,
    },
    initializationConfiguration: {
      disabledOnInitialization: false,
    },
  },
  alarmEventActions: {
    alarmActions: [{
      dynamoDb: {
        hashKeyField: 'hashKeyField',
        hashKeyType: 'hashKeyType',
        hashKeyValue: 'hashKeyValue',
        operation: 'operation',
        payload: {
          contentExpression: 'contentExpression',
          type: 'type',
        },
        payloadField: 'payloadField',
        rangeKeyField: 'rangeKeyField',
        rangeKeyType: 'rangeKeyType',
        rangeKeyValue: 'rangeKeyValue',
        tableName: 'tableName',
      },
      dynamoDBv2: {
        payload: {
          contentExpression: 'contentExpression',
          type: 'type',
        },
        tableName: 'tableName',
      },
      firehose: {
        deliveryStreamName: 'deliveryStreamName',
        payload: {
          contentExpression: 'contentExpression',
          type: 'type',
        },
        separator: 'separator',
      },
      iotEvents: {
        inputName: 'inputName',
        payload: {
          contentExpression: 'contentExpression',
          type: 'type',
        },
      },
      iotSiteWise: {
        assetId: 'assetId',
        entryId: 'entryId',
        propertyAlias: 'propertyAlias',
        propertyId: 'propertyId',
        propertyValue: {
          quality: 'quality',
          timestamp: {
            offsetInNanos: 'offsetInNanos',
            timeInSeconds: 'timeInSeconds',
          },
          value: {
            booleanValue: 'booleanValue',
            doubleValue: 'doubleValue',
            integerValue: 'integerValue',
            stringValue: 'stringValue',
          },
        },
      },
      iotTopicPublish: {
        mqttTopic: 'mqttTopic',
        payload: {
          contentExpression: 'contentExpression',
          type: 'type',
        },
      },
      lambda: {
        functionArn: 'functionArn',
        payload: {
          contentExpression: 'contentExpression',
          type: 'type',
        },
      },
      sns: {
        payload: {
          contentExpression: 'contentExpression',
          type: 'type',
        },
        targetArn: 'targetArn',
      },
      sqs: {
        payload: {
          contentExpression: 'contentExpression',
          type: 'type',
        },
        queueUrl: 'queueUrl',
        useBase64: false,
      },
    }],
  },
  alarmModelDescription: 'alarmModelDescription',
  alarmModelName: 'alarmModelName',
  alarmRule: {
    simpleRule: {
      comparisonOperator: 'comparisonOperator',
      inputProperty: 'inputProperty',
      threshold: 'threshold',
    },
  },
  key: 'key',
  roleArn: 'roleArn',
  severity: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnAlarmModelPropsMixin(props: CfnAlarmModelMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::IoTEvents::AlarmModel.

Properties

Name	Type	Description
props	CfnAlarmModelMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnAlarmModelMixinProps

---

strategy

Type: IMergeStrategy

---

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): void

Parameters

• construct 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.