CfnAlarmModel

class aws_cdk.aws_iotevents.CfnAlarmModel(scope, id, *, 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: CfnResource

A CloudFormation AWS::IoTEvents::AlarmModel.

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 .

CloudformationResource:: AWS::IoTEvents::AlarmModel
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 = iotevents.CfnAlarmModel(self, "MyCfnAlarmModel",
    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"
    )]
)

Create a new AWS::IoTEvents::AlarmModel.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::IoTEvents::AlarmModel'

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

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

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

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

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

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

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

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

AcknowledgeFlowProperty

class CfnAlarmModel.AcknowledgeFlowProperty(*, enabled=None)

Bases: object

Specifies whether to get notified for alarm state changes.

Parameters:: enabled (Union[bool, IResolvable, None]) – The value must be TRUE or FALSE . If TRUE , you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL . If FALSE , you won’t receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.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

acknowledge_flow_property = iotevents.CfnAlarmModel.AcknowledgeFlowProperty(
    enabled=False
)

Attributes

enabled

The value must be TRUE or FALSE .

If TRUE , you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL . If FALSE , you won’t receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.html#cfn-iotevents-alarmmodel-acknowledgeflow-enabled

AlarmActionProperty

class CfnAlarmModel.AlarmActionProperty(*, dynamo_db=None, dynamo_d_bv2=None, firehose=None, iot_events=None, iot_site_wise=None, iot_topic_publish=None, lambda_=None, sns=None, sqs=None)

Bases: object

Specifies one of the following actions to receive notifications when the alarm state changes.

Parameters:

dynamo_db (Union[IResolvable, DynamoDBProperty, Dict[str, Any], None]) – Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. You must use expressions for all parameters in DynamoDBAction . The expressions accept literals, operators, functions, references, and substitution templates. Examples - For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING' . - For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name . - For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the hashKeyValue parameter uses a substitution template. '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit' - For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the tableName parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date For more information, see Expressions in the AWS IoT Events Developer Guide . If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw .
dynamo_d_bv2 (Union[IResolvable, DynamoDBv2Property, Dict[str, Any], None]) –
Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. You must use expressions for all parameters in DynamoDBv2Action . The expressions accept literals, operators, functions, references, and substitution templates. Examples - For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable' . - For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName . - For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the contentExpression parameter in Payload uses a substitution template. '{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}' - For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the tableName parameter uses a string concatenation. 'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date For more information, see Expressions in the AWS IoT Events Developer Guide . The value for the type parameter in Payload must be JSON .
firehose (Union[IResolvable, FirehoseProperty, Dict[str, Any], None]) – Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
iot_events (Union[IResolvable, IotEventsProperty, Dict[str, Any], None]) – Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
iot_site_wise (Union[IResolvable, IotSiteWiseProperty, Dict[str, Any], None]) –
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise . You must use expressions for all parameters in IotSiteWiseAction . The expressions accept literals, operators, functions, references, and substitutions templates. Examples - For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature' . - For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1 . - For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. In the following example, the value for the propertyAlias parameter uses a substitution template. 'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature' You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise . For more information, see Expressions in the AWS IoT Events Developer Guide .
iot_topic_publish (Union[IResolvable, IotTopicPublishProperty, Dict[str, Any], None]) – Information required to publish the MQTT message through the AWS IoT message broker.
lambda – Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
sns (Union[IResolvable, SnsProperty, Dict[str, Any], None]) – Information required to publish the Amazon SNS message.
sqs (Union[IResolvable, SqsProperty, Dict[str, Any], None]) – Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.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

alarm_action_property = 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
    )
)

Attributes

dynamo_d_bv2

Defines an action to write to the Amazon DynamoDB table that you created.

The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable' .

For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName .
For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the tableName parameter uses a string concatenation.

'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide .

The value for the type parameter in Payload must be JSON .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-dynamodbv2

dynamo_db

Defines an action to write to the Amazon DynamoDB table that you created.

The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING' .

For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name .
For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the hashKeyValue parameter uses a substitution template.

'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the tableName parameter uses a string concatenation.

'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide .

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-dynamodb

firehose

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-firehose

iot_events

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iotevents

iot_site_wise

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .

You must use expressions for all parameters in IotSiteWiseAction . The expressions accept literals, operators, functions, references, and substitutions templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature' .

For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1 .
For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the propertyAlias parameter uses a substitution template.

'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise .

For more information, see Expressions in the AWS IoT Events Developer Guide .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iotsitewise

iot_topic_publish

Information required to publish the MQTT message through the AWS IoT message broker.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iottopicpublish

lambda_

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-lambda

sns

Information required to publish the Amazon SNS message.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-sns

sqs

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-sqs

AlarmCapabilitiesProperty

class CfnAlarmModel.AlarmCapabilitiesProperty(*, acknowledge_flow=None, initialization_configuration=None)

Bases: object

Contains the configuration information of alarm state changes.

Parameters:

acknowledge_flow (Union[IResolvable, AcknowledgeFlowProperty, Dict[str, Any], None]) – Specifies whether to get notified for alarm state changes.
initialization_configuration (Union[IResolvable, InitializationConfigurationProperty, Dict[str, Any], None]) – Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.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

alarm_capabilities_property = iotevents.CfnAlarmModel.AlarmCapabilitiesProperty(
    acknowledge_flow=iotevents.CfnAlarmModel.AcknowledgeFlowProperty(
        enabled=False
    ),
    initialization_configuration=iotevents.CfnAlarmModel.InitializationConfigurationProperty(
        disabled_on_initialization=False
    )
)

Attributes

acknowledge_flow

Specifies whether to get notified for alarm state changes.

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

initialization_configuration

Specifies the default alarm state.

The configuration applies to all alarms that were created based on this alarm model.

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

AlarmEventActionsProperty

class CfnAlarmModel.AlarmEventActionsProperty(*, alarm_actions=None)

Bases: object

Contains information about one or more alarm actions.

Parameters:: alarm_actions (Union[IResolvable, Sequence[Union[IResolvable, AlarmActionProperty, Dict[str, Any]]], None]) – Specifies one or more supported actions to receive notifications when the alarm state changes.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmeventactions.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

alarm_event_actions_property = 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
        )
    )]
)

Attributes

alarm_actions

Specifies one or more supported actions to receive notifications when the alarm state changes.

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

AlarmRuleProperty

class CfnAlarmModel.AlarmRuleProperty(*, simple_rule=None)

Bases: object

Defines when your alarm is invoked.

Parameters:: simple_rule (Union[IResolvable, SimpleRuleProperty, Dict[str, Any], None]) – A rule that compares an input property value to a threshold value with a comparison operator.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmrule.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

alarm_rule_property = iotevents.CfnAlarmModel.AlarmRuleProperty(
    simple_rule=iotevents.CfnAlarmModel.SimpleRuleProperty(
        comparison_operator="comparisonOperator",
        input_property="inputProperty",
        threshold="threshold"
    )
)

Attributes

simple_rule

A rule that compares an input property value to a threshold value with a comparison operator.

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

AssetPropertyTimestampProperty

class CfnAlarmModel.AssetPropertyTimestampProperty(*, time_in_seconds, offset_in_nanos=None)

Bases: object

A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference .

You must use expressions for all parameters in AssetPropertyTimestamp . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the timeInSeconds parameter can be '1586400675' .

For references, you must specify either variables or input values. For example, the value for the offsetInNanos parameter can be $variable.time .
For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the timeInSeconds parameter uses a substitution template.

'${$input.TemperatureInput.sensorData.timestamp / 1000}'

For more information, see Expressions in the AWS IoT Events Developer Guide .

Parameters:

time_in_seconds (str) – The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
offset_in_nanos (Optional[str]) – The nanosecond offset converted from timeInSeconds . The valid range is between 0-999999999.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.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

asset_property_timestamp_property = iotevents.CfnAlarmModel.AssetPropertyTimestampProperty(
    time_in_seconds="timeInSeconds",

    # the properties below are optional
    offset_in_nanos="offsetInNanos"
)

Attributes

offset_in_nanos

The nanosecond offset converted from timeInSeconds .

The valid range is between 0-999999999.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html#cfn-iotevents-alarmmodel-assetpropertytimestamp-offsetinnanos

time_in_seconds

The timestamp, in seconds, in the Unix epoch format.

The valid range is between 1-31556889864403199.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html#cfn-iotevents-alarmmodel-assetpropertytimestamp-timeinseconds

AssetPropertyValueProperty

class CfnAlarmModel.AssetPropertyValueProperty(*, value, quality=None, timestamp=None)

Bases: object

A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference .

You must use expressions for all parameters in AssetPropertyValue . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the quality parameter can be 'GOOD' .

For references, you must specify either variables or input values. For example, the value for the quality parameter can be $input.TemperatureInput.sensorData.quality .

For more information, see Expressions in the AWS IoT Events Developer Guide .

Parameters:

value (Union[IResolvable, AssetPropertyVariantProperty, Dict[str, Any]]) – The value to send to an asset property.
quality (Optional[str]) – The quality of the asset property value. The value must be 'GOOD' , 'BAD' , or 'UNCERTAIN' .
timestamp (Union[IResolvable, AssetPropertyTimestampProperty, Dict[str, Any], None]) – The timestamp associated with the asset property value. The default is the current event time.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.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

asset_property_value_property = 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"
    )
)

Attributes

quality

The quality of the asset property value.

The value must be 'GOOD' , 'BAD' , or 'UNCERTAIN' .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-quality

timestamp

The timestamp associated with the asset property value.

The default is the current event time.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-timestamp

value

The value to send to an asset property.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-value

AssetPropertyVariantProperty

class CfnAlarmModel.AssetPropertyVariantProperty(*, boolean_value=None, double_value=None, integer_value=None, string_value=None)

Bases: object

A structure that contains an asset property value.

For more information, see Variant in the AWS IoT SiteWise API Reference .

You must use expressions for all parameters in AssetPropertyVariant . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the integerValue parameter can be '100' .

For references, you must specify either variables or parameters. For example, the value for the booleanValue parameter can be $variable.offline .
For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the doubleValue parameter uses a substitution template.

'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'

For more information, see Expressions in the AWS IoT Events Developer Guide .

You must specify one of the following value types, depending on the dataType of the specified asset property. For more information, see AssetProperty in the AWS IoT SiteWise API Reference .

Parameters:

boolean_value (Optional[str]) – The asset property value is a Boolean value that must be 'TRUE' or 'FALSE' . You must use an expression, and the evaluated result should be a Boolean value.
double_value (Optional[str]) – The asset property value is a double. You must use an expression, and the evaluated result should be a double.
integer_value (Optional[str]) – The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
string_value (Optional[str]) – The asset property value is a string. You must use an expression, and the evaluated result should be a string.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.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

asset_property_variant_property = iotevents.CfnAlarmModel.AssetPropertyVariantProperty(
    boolean_value="booleanValue",
    double_value="doubleValue",
    integer_value="integerValue",
    string_value="stringValue"
)

Attributes

boolean_value

The asset property value is a Boolean value that must be 'TRUE' or 'FALSE' .

You must use an expression, and the evaluated result should be a Boolean value.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-booleanvalue

double_value

The asset property value is a double.

You must use an expression, and the evaluated result should be a double.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-doublevalue

integer_value

The asset property value is an integer.

You must use an expression, and the evaluated result should be an integer.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-integervalue

string_value

The asset property value is a string.

You must use an expression, and the evaluated result should be a string.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-stringvalue

DynamoDBProperty

class CfnAlarmModel.DynamoDBProperty(*, hash_key_field, hash_key_value, table_name, hash_key_type=None, operation=None, payload=None, payload_field=None, range_key_field=None, range_key_type=None, range_key_value=None)

Bases: object

Defines an action to write to the Amazon DynamoDB table that you created.

The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in DynamoDBAction . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING' .

For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name .
For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the hashKeyValue parameter uses a substitution template.

'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the tableName parameter uses a string concatenation.

'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide .

If the defined payload type is a string, DynamoDBAction writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the payloadField parameter is <payload-field>_raw .

Parameters:

hash_key_field (str) – The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.
hash_key_value (str) – The value of the hash key (also called the partition key).
table_name (str) – The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table.
hash_key_type (Optional[str]) – The data type for the hash key (also called the partition key). You can specify the following values:. - 'STRING' - The hash key is a string. - 'NUMBER' - The hash key is a number. If you don’t specify hashKeyType , the default value is 'STRING' .
operation (Optional[str]) – The type of operation to perform. You can specify the following values:. - 'INSERT' - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key. - 'UPDATE' - Update an existing item of the DynamoDB table with new data. This item’s partition key must match the specified hash key. If you specified a range key, the range key must match the item’s sort key. - 'DELETE' - Delete an existing item of the DynamoDB table. This item’s partition key must match the specified hash key. If you specified a range key, the range key must match the item’s sort key. If you don’t specify this parameter, AWS IoT Events triggers the 'INSERT' operation.
payload (Union[IResolvable, PayloadProperty, Dict[str, Any], None]) – Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .
payload_field (Optional[str]) – The name of the DynamoDB column that receives the action payload. If you don’t specify this parameter, the name of the DynamoDB column is payload .
range_key_field (Optional[str]) – The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.
range_key_type (Optional[str]) – The data type for the range key (also called the sort key), You can specify the following values:. - 'STRING' - The range key is a string. - 'NUMBER' - The range key is number. If you don’t specify rangeKeyField , the default value is 'STRING' .
range_key_value (Optional[str]) – The value of the range key (also called the sort key).

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.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

dynamo_dBProperty = 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"
)

Attributes

hash_key_field

The name of the hash key (also called the partition key).

The hashKeyField value must match the partition key of the target DynamoDB table.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeyfield

hash_key_type

.

'STRING' - The hash key is a string.
'NUMBER' - The hash key is a number.

If you don’t specify hashKeyType , the default value is 'STRING' .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeytype
Type:: The data type for the hash key (also called the partition key). You can specify the following values

hash_key_value

The value of the hash key (also called the partition key).

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeyvalue

operation

.

'INSERT' - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.
'UPDATE' - Update an existing item of the DynamoDB table with new data. This item’s partition key must match the specified hash key. If you specified a range key, the range key must match the item’s sort key.
'DELETE' - Delete an existing item of the DynamoDB table. This item’s partition key must match the specified hash key. If you specified a range key, the range key must match the item’s sort key.

If you don’t specify this parameter, AWS IoT Events triggers the 'INSERT' operation.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-operation
Type:: The type of operation to perform. You can specify the following values

payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-payload

payload_field

The name of the DynamoDB column that receives the action payload.

If you don’t specify this parameter, the name of the DynamoDB column is payload .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-payloadfield

range_key_field

The name of the range key (also called the sort key).

The rangeKeyField value must match the sort key of the target DynamoDB table.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeyfield

range_key_type

.

'STRING' - The range key is a string.
'NUMBER' - The range key is number.

If you don’t specify rangeKeyField , the default value is 'STRING' .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeytype
Type:: The data type for the range key (also called the sort key), You can specify the following values

range_key_value

The value of the range key (also called the sort key).

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeyvalue

table_name

The name of the DynamoDB table.

The tableName value must match the table name of the target DynamoDB table.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-tablename

DynamoDBv2Property

class CfnAlarmModel.DynamoDBv2Property(*, table_name, payload=None)

Bases: object

Defines an action to write to the Amazon DynamoDB table that you created.

The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the payload . A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.

You must use expressions for all parameters in DynamoDBv2Action . The expressions accept literals, operators, functions, references, and substitution templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the tableName parameter can be 'GreenhouseTemperatureTable' .

For references, you must specify either variables or input values. For example, the value for the tableName parameter can be $variable.ddbtableName .
For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the contentExpression parameter in Payload uses a substitution template.

'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\": \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'

For a string concatenation, you must use + . A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the tableName parameter uses a string concatenation.

'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions in the AWS IoT Events Developer Guide .

The value for the type parameter in Payload must be JSON .

Parameters:

table_name (str) – The name of the DynamoDB table.
payload (Union[IResolvable, PayloadProperty, Dict[str, Any], None]) – Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.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

dynamo_dBv2_property = iotevents.CfnAlarmModel.DynamoDBv2Property(
    table_name="tableName",

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

Attributes

payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html#cfn-iotevents-alarmmodel-dynamodbv2-payload

table_name

The name of the DynamoDB table.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html#cfn-iotevents-alarmmodel-dynamodbv2-tablename

FirehoseProperty

class CfnAlarmModel.FirehoseProperty(*, delivery_stream_name, payload=None, separator=None)

Bases: object

Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.

Parameters:

delivery_stream_name (str) – The name of the Kinesis Data Firehose delivery stream where the data is written.
payload (Union[IResolvable, PayloadProperty, Dict[str, Any], None]) – You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.
separator (Optional[str]) – A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: ‘n’ (newline), ‘t’ (tab), ‘rn’ (Windows newline), ‘,’ (comma).

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.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

firehose_property = iotevents.CfnAlarmModel.FirehoseProperty(
    delivery_stream_name="deliveryStreamName",

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

Attributes

delivery_stream_name

The name of the Kinesis Data Firehose delivery stream where the data is written.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-deliverystreamname

payload

You can configure the action payload when you send a message to an Amazon Kinesis Data Firehose delivery stream.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-payload

separator

A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream.

Valid values are: ‘n’ (newline), ‘t’ (tab), ‘rn’ (Windows newline), ‘,’ (comma).

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-separator

InitializationConfigurationProperty

class CfnAlarmModel.InitializationConfigurationProperty(*, disabled_on_initialization)

Bases: object

Specifies the default alarm state.

The configuration applies to all alarms that were created based on this alarm model.

Parameters:: disabled_on_initialization (Union[bool, IResolvable]) – The value must be TRUE or FALSE . If FALSE , all alarm instances created based on the alarm model are activated. The default value is TRUE .
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.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

initialization_configuration_property = iotevents.CfnAlarmModel.InitializationConfigurationProperty(
    disabled_on_initialization=False
)

Attributes

disabled_on_initialization

The value must be TRUE or FALSE .

If FALSE , all alarm instances created based on the alarm model are activated. The default value is TRUE .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.html#cfn-iotevents-alarmmodel-initializationconfiguration-disabledoninitialization

IotEventsProperty

class CfnAlarmModel.IotEventsProperty(*, input_name, payload=None)

Bases: object

Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.

Parameters:

input_name (str) – The name of the AWS IoT Events input where the data is sent.
payload (Union[IResolvable, PayloadProperty, Dict[str, Any], None]) – You can configure the action payload when you send a message to an AWS IoT Events input.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.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

iot_events_property = iotevents.CfnAlarmModel.IotEventsProperty(
    input_name="inputName",

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

Attributes

input_name

The name of the AWS IoT Events input where the data is sent.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html#cfn-iotevents-alarmmodel-iotevents-inputname

payload

You can configure the action payload when you send a message to an AWS IoT Events input.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html#cfn-iotevents-alarmmodel-iotevents-payload

IotSiteWiseProperty

class CfnAlarmModel.IotSiteWiseProperty(*, asset_id=None, entry_id=None, property_alias=None, property_id=None, property_value=None)

Bases: object

Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise .

You must use expressions for all parameters in IotSiteWiseAction . The expressions accept literals, operators, functions, references, and substitutions templates.

Examples - For literal values, the expressions must contain single quotes. For example, the value for the propertyAlias parameter can be '/company/windfarm/3/turbine/7/temperature' .

For references, you must specify either variables or input values. For example, the value for the assetId parameter can be $input.TurbineInput.assetId1 .
For a substitution template, you must use ${} , and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

In the following example, the value for the propertyAlias parameter uses a substitution template.

'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'

You must specify either propertyAlias or both assetId and propertyId to identify the target asset property in AWS IoT SiteWise .

For more information, see Expressions in the AWS IoT Events Developer Guide .

Parameters:

asset_id (Optional[str]) – The ID of the asset that has the specified property.
entry_id (Optional[str]) – A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
property_alias (Optional[str]) – The alias of the asset property.
property_id (Optional[str]) – The ID of the asset property.
property_value (Union[IResolvable, AssetPropertyValueProperty, Dict[str, Any], None]) – The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.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

iot_site_wise_property = 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"
        )
    )
)

Attributes

asset_id

The ID of the asset that has the specified property.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-assetid

entry_id

A unique identifier for this entry.

You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-entryid

property_alias

The alias of the asset property.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyalias

property_id

The ID of the asset property.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyid

property_value

The value to send to the asset property.

This value contains timestamp, quality, and value (TQV) information.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyvalue

IotTopicPublishProperty

class CfnAlarmModel.IotTopicPublishProperty(*, mqtt_topic, payload=None)

Bases: object

Information required to publish the MQTT message through the AWS IoT message broker.

Parameters:

mqtt_topic (str) – The MQTT topic of the message. You can use a string expression that includes variables ( $variable.<variable-name> ) and input values ( $input.<input-name>.<path-to-datum> ) as the topic string.
payload (Union[IResolvable, PayloadProperty, Dict[str, Any], None]) – You can configure the action payload when you publish a message to an AWS IoT Core topic.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.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

iot_topic_publish_property = iotevents.CfnAlarmModel.IotTopicPublishProperty(
    mqtt_topic="mqttTopic",

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

Attributes

mqtt_topic

The MQTT topic of the message.

You can use a string expression that includes variables ( $variable.<variable-name> ) and input values ( $input.<input-name>.<path-to-datum> ) as the topic string.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html#cfn-iotevents-alarmmodel-iottopicpublish-mqtttopic

payload

You can configure the action payload when you publish a message to an AWS IoT Core topic.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html#cfn-iotevents-alarmmodel-iottopicpublish-payload

LambdaProperty

class CfnAlarmModel.LambdaProperty(*, function_arn, payload=None)

Bases: object

Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.

Parameters:

function_arn (str) – The ARN of the Lambda function that is executed.
payload (Union[IResolvable, PayloadProperty, Dict[str, Any], None]) – You can configure the action payload when you send a message to a Lambda function.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.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

lambda_property = iotevents.CfnAlarmModel.LambdaProperty(
    function_arn="functionArn",

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

Attributes

function_arn

The ARN of the Lambda function that is executed.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html#cfn-iotevents-alarmmodel-lambda-functionarn

payload

You can configure the action payload when you send a message to a Lambda function.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html#cfn-iotevents-alarmmodel-lambda-payload

PayloadProperty

class CfnAlarmModel.PayloadProperty(*, content_expression, type)

Bases: object

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression .

Parameters:

content_expression (str) – The content of the payload. You can use a string expression that includes quoted strings ( '<string>' ), variables ( $variable.<variable-name> ), input values ( $input.<input-name>.<path-to-datum> ), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.
type (str) – The value of the payload type can be either STRING or JSON .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.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

payload_property = iotevents.CfnAlarmModel.PayloadProperty(
    content_expression="contentExpression",
    type="type"
)

Attributes

content_expression

The content of the payload.

You can use a string expression that includes quoted strings ( '<string>' ), variables ( $variable.<variable-name> ), input values ( $input.<input-name>.<path-to-datum> ), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html#cfn-iotevents-alarmmodel-payload-contentexpression

type

The value of the payload type can be either STRING or JSON .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html#cfn-iotevents-alarmmodel-payload-type

SimpleRuleProperty

class CfnAlarmModel.SimpleRuleProperty(*, comparison_operator, input_property, threshold)

Bases: object

A rule that compares an input property value to a threshold value with a comparison operator.

Parameters:

comparison_operator (str) – The comparison operator.
input_property (str) – The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.
threshold (str) – The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.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

simple_rule_property = iotevents.CfnAlarmModel.SimpleRuleProperty(
    comparison_operator="comparisonOperator",
    input_property="inputProperty",
    threshold="threshold"
)

Attributes

comparison_operator

The comparison operator.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-comparisonoperator

input_property

The value on the left side of the comparison operator.

You can specify an AWS IoT Events input attribute as an input property.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-inputproperty

threshold

The value on the right side of the comparison operator.

You can enter a number or specify an AWS IoT Events input attribute.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-threshold

SnsProperty

class CfnAlarmModel.SnsProperty(*, target_arn, payload=None)

Bases: object

Information required to publish the Amazon SNS message.

Parameters:

target_arn (str) – The ARN of the Amazon SNS target where the message is sent.
payload (Union[IResolvable, PayloadProperty, Dict[str, Any], None]) – You can configure the action payload when you send a message as an Amazon SNS push notification.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.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

sns_property = iotevents.CfnAlarmModel.SnsProperty(
    target_arn="targetArn",

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

Attributes

payload

You can configure the action payload when you send a message as an Amazon SNS push notification.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html#cfn-iotevents-alarmmodel-sns-payload

target_arn

The ARN of the Amazon SNS target where the message is sent.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html#cfn-iotevents-alarmmodel-sns-targetarn

SqsProperty

class CfnAlarmModel.SqsProperty(*, queue_url, payload=None, use_base64=None)

Bases: object

Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.

Parameters:

queue_url (str) – The URL of the SQS queue where the data is written.
payload (Union[IResolvable, PayloadProperty, Dict[str, Any], None]) – You can configure the action payload when you send a message to an Amazon SQS queue.
use_base64 (Union[bool, IResolvable, None]) – Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.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

sqs_property = iotevents.CfnAlarmModel.SqsProperty(
    queue_url="queueUrl",

    # the properties below are optional
    payload=iotevents.CfnAlarmModel.PayloadProperty(
        content_expression="contentExpression",
        type="type"
    ),
    use_base64=False
)

Attributes

payload

You can configure the action payload when you send a message to an Amazon SQS queue.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-payload

queue_url

The URL of the SQS queue where the data is written.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-queueurl

use_base64

Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue.

Otherwise, set this to FALSE.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-usebase64