interface CfnAlarmModelMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoTEvents.Mixins.CfnAlarmModelMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotevents/mixins#CfnAlarmModelMixinProps
Java	software.amazon.awscdk.mixins.preview.services.iotevents.mixins.CfnAlarmModelMixinProps
Python	aws_cdk.mixins_preview.aws_iotevents.mixins.CfnAlarmModelMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_iotevents » mixins » CfnAlarmModelMixinProps

Properties for CfnAlarmModelPropsMixin.

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 { mixins as iotevents_mixins } from '@aws-cdk/mixins-preview/aws-iotevents';
const cfnAlarmModelMixinProps: iotevents_mixins.CfnAlarmModelMixinProps = {
  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',
  }],
};

Properties

Name	Type	Description
alarmCapabilities?	IResolvable | AlarmCapabilitiesProperty	Contains the configuration information of alarm state changes.
alarmEventActions?	IResolvable | AlarmEventActionsProperty	Contains information about one or more alarm actions.
alarmModelDescription?	string	The description of the alarm model.
alarmModelName?	string	The name of the alarm model.
alarmRule?	IResolvable | AlarmRuleProperty	Defines when your alarm is invoked.
key?	string	An input attribute used as a key to create an alarm.
roleArn?	string	The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
severity?	number	A non-negative integer that reflects the severity level of the alarm.
tags?	CfnTag[]	A list of key-value pairs that contain metadata for the alarm model.

---

alarmCapabilities?

Type: IResolvable | AlarmCapabilitiesProperty (optional)

Contains the configuration information of alarm state changes.

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

---

alarmEventActions?

Type: IResolvable | AlarmEventActionsProperty (optional)

Contains information about one or more alarm actions.

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

---

alarmModelDescription?

Type: string (optional)

The description of the alarm model.

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

---

alarmModelName?

Type: string (optional)

The name of the alarm model.

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

---

alarmRule?

Type: IResolvable | AlarmRuleProperty (optional)

Defines when your alarm is invoked.

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

---

key?

Type: string (optional)

An input attribute used as a key to create an alarm.

AWS IoT Events routes inputs associated with this key to the alarm.

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

---

roleArn?

Type: string (optional)

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.

For more information, see Amazon Resource Names (ARNs) in the AWS General Reference .

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

---

severity?

Type: number (optional)

A non-negative integer that reflects the severity level of the alarm.

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

---

tags?

Type: CfnTag[] (optional)

A list of key-value pairs that contain metadata for the alarm model.

The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide .

You can create up to 50 tags for one alarm model.

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