CfnAlarmModelProps

class aws_cdk.aws_iotevents.CfnAlarmModelProps(*, alarm_rule, role_arn, alarm_capabilities=None, alarm_event_actions=None, alarm_model_description=None, alarm_model_name=None, key=None, severity=None, tags=None)

Bases: object

Properties for defining a CfnAlarmModel.

Parameters
  • alarm_rule (Union[AlarmRuleProperty, Dict[str, Any], IResolvable]) – Defines when your alarm is invoked.

  • role_arn (str) – 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 .

  • alarm_capabilities (Union[IResolvable, AlarmCapabilitiesProperty, Dict[str, Any], None]) – Contains the configuration information of alarm state changes.

  • alarm_event_actions (Union[IResolvable, AlarmEventActionsProperty, Dict[str, Any], None]) – Contains information about one or more alarm actions.

  • alarm_model_description (Optional[str]) – The description of the alarm model.

  • alarm_model_name (Optional[str]) – The name of the alarm model.

  • key (Optional[str]) – An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

  • severity (Union[int, float, None]) – A non-negative integer that reflects the severity level of the alarm.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotevents as iotevents

cfn_alarm_model_props = iotevents.CfnAlarmModelProps(
    alarm_rule=iotevents.CfnAlarmModel.AlarmRuleProperty(
        simple_rule=iotevents.CfnAlarmModel.SimpleRuleProperty(
            comparison_operator="comparisonOperator",
            input_property="inputProperty",
            threshold="threshold"
        )
    ),
    role_arn="roleArn",

    # the properties below are optional
    alarm_capabilities=iotevents.CfnAlarmModel.AlarmCapabilitiesProperty(
        acknowledge_flow=iotevents.CfnAlarmModel.AcknowledgeFlowProperty(
            enabled=False
        ),
        initialization_configuration=iotevents.CfnAlarmModel.InitializationConfigurationProperty(
            disabled_on_initialization=False
        )
    ),
    alarm_event_actions=iotevents.CfnAlarmModel.AlarmEventActionsProperty(
        alarm_actions=[iotevents.CfnAlarmModel.AlarmActionProperty(
            dynamo_db=iotevents.CfnAlarmModel.DynamoDBProperty(
                hash_key_field="hashKeyField",
                hash_key_value="hashKeyValue",
                table_name="tableName",

                # the properties below are optional
                hash_key_type="hashKeyType",
                operation="operation",
                payload=iotevents.CfnAlarmModel.PayloadProperty(
                    content_expression="contentExpression",
                    type="type"
                ),
                payload_field="payloadField",
                range_key_field="rangeKeyField",
                range_key_type="rangeKeyType",
                range_key_value="rangeKeyValue"
            ),
            dynamo_dBv2=iotevents.CfnAlarmModel.DynamoDBv2Property(
                table_name="tableName",

                # the properties below are optional
                payload=iotevents.CfnAlarmModel.PayloadProperty(
                    content_expression="contentExpression",
                    type="type"
                )
            ),
            firehose=iotevents.CfnAlarmModel.FirehoseProperty(
                delivery_stream_name="deliveryStreamName",

                # the properties below are optional
                payload=iotevents.CfnAlarmModel.PayloadProperty(
                    content_expression="contentExpression",
                    type="type"
                ),
                separator="separator"
            ),
            iot_events=iotevents.CfnAlarmModel.IotEventsProperty(
                input_name="inputName",

                # the properties below are optional
                payload=iotevents.CfnAlarmModel.PayloadProperty(
                    content_expression="contentExpression",
                    type="type"
                )
            ),
            iot_site_wise=iotevents.CfnAlarmModel.IotSiteWiseProperty(
                asset_id="assetId",
                entry_id="entryId",
                property_alias="propertyAlias",
                property_id="propertyId",
                property_value=iotevents.CfnAlarmModel.AssetPropertyValueProperty(
                    value=iotevents.CfnAlarmModel.AssetPropertyVariantProperty(
                        boolean_value="booleanValue",
                        double_value="doubleValue",
                        integer_value="integerValue",
                        string_value="stringValue"
                    ),

                    # the properties below are optional
                    quality="quality",
                    timestamp=iotevents.CfnAlarmModel.AssetPropertyTimestampProperty(
                        time_in_seconds="timeInSeconds",

                        # the properties below are optional
                        offset_in_nanos="offsetInNanos"
                    )
                )
            ),
            iot_topic_publish=iotevents.CfnAlarmModel.IotTopicPublishProperty(
                mqtt_topic="mqttTopic",

                # the properties below are optional
                payload=iotevents.CfnAlarmModel.PayloadProperty(
                    content_expression="contentExpression",
                    type="type"
                )
            ),
            lambda_=iotevents.CfnAlarmModel.LambdaProperty(
                function_arn="functionArn",

                # the properties below are optional
                payload=iotevents.CfnAlarmModel.PayloadProperty(
                    content_expression="contentExpression",
                    type="type"
                )
            ),
            sns=iotevents.CfnAlarmModel.SnsProperty(
                target_arn="targetArn",

                # the properties below are optional
                payload=iotevents.CfnAlarmModel.PayloadProperty(
                    content_expression="contentExpression",
                    type="type"
                )
            ),
            sqs=iotevents.CfnAlarmModel.SqsProperty(
                queue_url="queueUrl",

                # the properties below are optional
                payload=iotevents.CfnAlarmModel.PayloadProperty(
                    content_expression="contentExpression",
                    type="type"
                ),
                use_base64=False
            )
        )]
    ),
    alarm_model_description="alarmModelDescription",
    alarm_model_name="alarmModelName",
    key="key",
    severity=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

alarm_capabilities

Contains the configuration information of alarm state changes.

Link

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

Return type

Union[IResolvable, AlarmCapabilitiesProperty, None]

alarm_event_actions

Contains information about one or more alarm actions.

Link

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

Return type

Union[IResolvable, AlarmEventActionsProperty, None]

alarm_model_description

The description of the alarm model.

Link

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

Return type

Optional[str]

alarm_model_name

The name of the alarm model.

Link

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

Return type

Optional[str]

alarm_rule

Defines when your alarm is invoked.

Link

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

Return type

Union[AlarmRuleProperty, IResolvable]

key

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

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

Link

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

Return type

Optional[str]

role_arn

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 .

Link

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

Return type

str

severity

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

Link

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

Return type

Union[int, float, None]

tags

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.

Link

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

Return type

Optional[List[CfnTag]]