AWS Cloud Control v1.9.0, Nov 18 24

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iotevents.AlarmModel

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Create AlarmModel Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AlarmModel(name: string, args: AlarmModelArgs, opts?: CustomResourceOptions);

@overload
def AlarmModel(resource_name: str,
               args: AlarmModelArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def AlarmModel(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               alarm_rule: Optional[AlarmModelAlarmRuleArgs] = None,
               role_arn: Optional[str] = None,
               alarm_capabilities: Optional[AlarmModelAlarmCapabilitiesArgs] = None,
               alarm_event_actions: Optional[AlarmModelAlarmEventActionsArgs] = None,
               alarm_model_description: Optional[str] = None,
               alarm_model_name: Optional[str] = None,
               key: Optional[str] = None,
               severity: Optional[int] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)

func NewAlarmModel(ctx *Context, name string, args AlarmModelArgs, opts ...ResourceOption) (*AlarmModel, error)

public AlarmModel(string name, AlarmModelArgs args, CustomResourceOptions? opts = null)

public AlarmModel(String name, AlarmModelArgs args)
public AlarmModel(String name, AlarmModelArgs args, CustomResourceOptions options)

type: aws-native:iotevents:AlarmModel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args AlarmModelArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AlarmModelArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AlarmModelArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AlarmModelArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AlarmModelArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AlarmModel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AlarmModel resource accepts the following input properties:

AlarmRule Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAlarmRule: Defines when your alarm is invoked.
RoleArn string: 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 General Reference.
AlarmCapabilities Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAlarmCapabilities: Contains the configuration information of alarm state changes.
AlarmEventActions Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAlarmEventActions: Contains information about one or more alarm actions.
AlarmModelDescription string: The description of the alarm model.
AlarmModelName string: The name of the alarm model.
Key string: An input attribute used as a key to create an alarm. ITE routes inputs associated with this key to the alarm.
Severity int: A non-negative integer that reflects the severity level of the alarm.
Tags List<Pulumi.AwsNative.Inputs.Tag>: 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 resources in the Developer Guide. You can create up to 50 tags for one alarm model.

AlarmRule AlarmModelAlarmRuleArgs: Defines when your alarm is invoked.
RoleArn string: 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 General Reference.
AlarmCapabilities AlarmModelAlarmCapabilitiesArgs: Contains the configuration information of alarm state changes.
AlarmEventActions AlarmModelAlarmEventActionsArgs: Contains information about one or more alarm actions.
AlarmModelDescription string: The description of the alarm model.
AlarmModelName string: The name of the alarm model.
Key string: An input attribute used as a key to create an alarm. ITE routes inputs associated with this key to the alarm.
Severity int: A non-negative integer that reflects the severity level of the alarm.
Tags TagArgs: 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 resources in the Developer Guide. You can create up to 50 tags for one alarm model.

alarmRule AlarmModelAlarmRule: Defines when your alarm is invoked.
roleArn String: 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 General Reference.
alarmCapabilities AlarmModelAlarmCapabilities: Contains the configuration information of alarm state changes.
alarmEventActions AlarmModelAlarmEventActions: Contains information about one or more alarm actions.
alarmModelDescription String: The description of the alarm model.
alarmModelName String: The name of the alarm model.
key String: An input attribute used as a key to create an alarm. ITE routes inputs associated with this key to the alarm.
severity Integer: A non-negative integer that reflects the severity level of the alarm.
tags List<Tag>: 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 resources in the Developer Guide. You can create up to 50 tags for one alarm model.

alarmRule AlarmModelAlarmRule: Defines when your alarm is invoked.
roleArn string: 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 General Reference.
alarmCapabilities AlarmModelAlarmCapabilities: Contains the configuration information of alarm state changes.
alarmEventActions AlarmModelAlarmEventActions: Contains information about one or more alarm actions.
alarmModelDescription string: The description of the alarm model.
alarmModelName string: The name of the alarm model.
key string: An input attribute used as a key to create an alarm. ITE routes inputs associated with this key to the alarm.
severity number: A non-negative integer that reflects the severity level of the alarm.
tags Tag[]: 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 resources in the Developer Guide. You can create up to 50 tags for one alarm model.

alarm_rule AlarmModelAlarmRuleArgs: 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 General Reference.
alarm_capabilities AlarmModelAlarmCapabilitiesArgs: Contains the configuration information of alarm state changes.
alarm_event_actions AlarmModelAlarmEventActionsArgs: Contains information about one or more alarm actions.
alarm_model_description str: The description of the alarm model.
alarm_model_name str: The name of the alarm model.
key str: An input attribute used as a key to create an alarm. ITE routes inputs associated with this key to the alarm.
severity int: A non-negative integer that reflects the severity level of the alarm.
tags Sequence[TagArgs]: 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 resources in the Developer Guide. You can create up to 50 tags for one alarm model.

alarmRule Property Map: Defines when your alarm is invoked.
roleArn String: 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 General Reference.
alarmCapabilities Property Map: Contains the configuration information of alarm state changes.
alarmEventActions Property Map: Contains information about one or more alarm actions.
alarmModelDescription String: The description of the alarm model.
alarmModelName String: The name of the alarm model.
key String: An input attribute used as a key to create an alarm. ITE routes inputs associated with this key to the alarm.
severity Number: A non-negative integer that reflects the severity level of the alarm.
tags List<Property Map>: 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 resources in the Developer Guide. You can create up to 50 tags for one alarm model.

Outputs

All input properties are implicitly available as output properties. Additionally, the AlarmModel resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Supporting Types

AlarmModelAcknowledgeFlow, AlarmModelAcknowledgeFlowArgs

Enabled bool: 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.

Enabled bool: 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.

enabled Boolean: 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.

enabled boolean: 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.

enabled bool: 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.

enabled Boolean: 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.

AlarmModelAlarmAction, AlarmModelAlarmActionArgs

DynamoDBv2 Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelDynamoDBv2

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 Developer Guide. The value for the type parameter in Payload must be JSON.

DynamoDb Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelDynamoDb

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

Firehose Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelFirehose

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

IotEvents Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelIotEvents

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

IotSiteWise Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelIotSiteWise

Sends information about the detector model instance and the event that triggered the action to a specified asset property in ITSW. 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 ITSW. For more information, see Expressions in the Developer Guide.

IotTopicPublish Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelIotTopicPublish

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

Lambda Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelLambda

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

Sns Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelSns

Information required to publish the Amazon SNS message.

Sqs Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelSqs

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

DynamoDBv2 AlarmModelDynamoDBv2

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 Developer Guide. The value for the type parameter in Payload must be JSON.

DynamoDb AlarmModelDynamoDb

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

Firehose AlarmModelFirehose

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

IotEvents AlarmModelIotEvents

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

IotSiteWise AlarmModelIotSiteWise

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 ITSW. For more information, see Expressions in the Developer Guide.

IotTopicPublish AlarmModelIotTopicPublish

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

Lambda AlarmModelLambda

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

Sns AlarmModelSns

Information required to publish the Amazon SNS message.

Sqs AlarmModelSqs

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

dynamoDBv2 AlarmModelDynamoDBv2

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 Developer Guide. The value for the type parameter in Payload must be JSON.

dynamoDb AlarmModelDynamoDb

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

firehose AlarmModelFirehose

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

iotEvents AlarmModelIotEvents

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

iotSiteWise AlarmModelIotSiteWise

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 ITSW. For more information, see Expressions in the Developer Guide.

iotTopicPublish AlarmModelIotTopicPublish

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

lambda AlarmModelLambda

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

sns AlarmModelSns

Information required to publish the Amazon SNS message.

sqs AlarmModelSqs

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

dynamoDBv2 AlarmModelDynamoDBv2

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 Developer Guide. The value for the type parameter in Payload must be JSON.

dynamoDb AlarmModelDynamoDb

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

firehose AlarmModelFirehose

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

iotEvents AlarmModelIotEvents

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

iotSiteWise AlarmModelIotSiteWise

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 ITSW. For more information, see Expressions in the Developer Guide.

iotTopicPublish AlarmModelIotTopicPublish

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

lambda AlarmModelLambda

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

sns AlarmModelSns

Information required to publish the Amazon SNS message.

sqs AlarmModelSqs

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

dynamo_d_bv2 AlarmModelDynamoDBv2

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 Developer Guide. The value for the type parameter in Payload must be JSON.

dynamo_db AlarmModelDynamoDb

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

firehose AlarmModelFirehose

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

iot_events AlarmModelIotEvents

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

iot_site_wise AlarmModelIotSiteWise

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 ITSW. For more information, see Expressions in the Developer Guide.

iot_topic_publish AlarmModelIotTopicPublish

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

lambda_ AlarmModelLambda

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

sns AlarmModelSns

Information required to publish the Amazon SNS message.

sqs AlarmModelSqs

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

dynamoDBv2 Property Map

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 Developer Guide. The value for the type parameter in Payload must be JSON.

dynamoDb Property Map

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

firehose Property Map

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

iotEvents Property Map

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

iotSiteWise Property Map

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 ITSW. For more information, see Expressions in the Developer Guide.

iotTopicPublish Property Map

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

lambda Property Map

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

sns Property Map

Information required to publish the Amazon SNS message.

sqs Property Map

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

AlarmModelAlarmCapabilities, AlarmModelAlarmCapabilitiesArgs

AcknowledgeFlow Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAcknowledgeFlow: Specifies whether to get notified for alarm state changes.
InitializationConfiguration Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelInitializationConfiguration: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

AcknowledgeFlow AlarmModelAcknowledgeFlow: Specifies whether to get notified for alarm state changes.
InitializationConfiguration AlarmModelInitializationConfiguration: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

acknowledgeFlow AlarmModelAcknowledgeFlow: Specifies whether to get notified for alarm state changes.
initializationConfiguration AlarmModelInitializationConfiguration: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

acknowledgeFlow AlarmModelAcknowledgeFlow: Specifies whether to get notified for alarm state changes.
initializationConfiguration AlarmModelInitializationConfiguration: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

acknowledge_flow AlarmModelAcknowledgeFlow: Specifies whether to get notified for alarm state changes.
initialization_configuration AlarmModelInitializationConfiguration: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

acknowledgeFlow Property Map: Specifies whether to get notified for alarm state changes.
initializationConfiguration Property Map: Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.

AlarmModelAlarmEventActions, AlarmModelAlarmEventActionsArgs

AlarmActions List<Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAlarmAction>: Specifies one or more supported actions to receive notifications when the alarm state changes.

AlarmActions []AlarmModelAlarmAction: Specifies one or more supported actions to receive notifications when the alarm state changes.

alarmActions List<AlarmModelAlarmAction>: Specifies one or more supported actions to receive notifications when the alarm state changes.

alarmActions AlarmModelAlarmAction[]: Specifies one or more supported actions to receive notifications when the alarm state changes.

alarm_actions Sequence[AlarmModelAlarmAction]: Specifies one or more supported actions to receive notifications when the alarm state changes.

alarmActions List<Property Map>: Specifies one or more supported actions to receive notifications when the alarm state changes.

AlarmModelAlarmRule, AlarmModelAlarmRuleArgs

SimpleRule Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelSimpleRule: A rule that compares an input property value to a threshold value with a comparison operator.

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

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

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

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

simpleRule Property Map: A rule that compares an input property value to a threshold value with a comparison operator.

AlarmModelAssetPropertyTimestamp, AlarmModelAssetPropertyTimestampArgs

TimeInSeconds string: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
OffsetInNanos string: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.

TimeInSeconds string: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
OffsetInNanos string: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.

timeInSeconds String: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
offsetInNanos String: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.

timeInSeconds string: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
offsetInNanos string: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.

time_in_seconds str: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
offset_in_nanos str: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.

timeInSeconds String: The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
offsetInNanos String: The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999.

AlarmModelAssetPropertyValue, AlarmModelAssetPropertyValueArgs

Value Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAssetPropertyVariant: The value to send to an asset property.
Quality string: The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'.
Timestamp Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAssetPropertyTimestamp: The timestamp associated with the asset property value. The default is the current event time.

Value AlarmModelAssetPropertyVariant: The value to send to an asset property.
Quality string: The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'.
Timestamp AlarmModelAssetPropertyTimestamp: The timestamp associated with the asset property value. The default is the current event time.

value AlarmModelAssetPropertyVariant: The value to send to an asset property.
quality String: The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'.
timestamp AlarmModelAssetPropertyTimestamp: The timestamp associated with the asset property value. The default is the current event time.

value AlarmModelAssetPropertyVariant: The value to send to an asset property.
quality string: The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'.
timestamp AlarmModelAssetPropertyTimestamp: The timestamp associated with the asset property value. The default is the current event time.

value AlarmModelAssetPropertyVariant: The value to send to an asset property.
quality str: The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'.
timestamp AlarmModelAssetPropertyTimestamp: The timestamp associated with the asset property value. The default is the current event time.

value Property Map: The value to send to an asset property.
quality String: The quality of the asset property value. The value must be 'GOOD', 'BAD', or 'UNCERTAIN'.
timestamp Property Map: The timestamp associated with the asset property value. The default is the current event time.

AlarmModelAssetPropertyVariant, AlarmModelAssetPropertyVariantArgs

BooleanValue string: 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.
DoubleValue string: The asset property value is a double. You must use an expression, and the evaluated result should be a double.
IntegerValue string: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
StringValue string: The asset property value is a string. You must use an expression, and the evaluated result should be a string.

BooleanValue string: 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.
DoubleValue string: The asset property value is a double. You must use an expression, and the evaluated result should be a double.
IntegerValue string: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
StringValue string: The asset property value is a string. You must use an expression, and the evaluated result should be a string.

booleanValue String: 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.
doubleValue String: The asset property value is a double. You must use an expression, and the evaluated result should be a double.
integerValue String: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
stringValue String: The asset property value is a string. You must use an expression, and the evaluated result should be a string.

booleanValue string: 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.
doubleValue string: The asset property value is a double. You must use an expression, and the evaluated result should be a double.
integerValue string: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
stringValue string: The asset property value is a string. You must use an expression, and the evaluated result should be a string.

boolean_value 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 str: The asset property value is a double. You must use an expression, and the evaluated result should be a double.
integer_value str: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
string_value str: The asset property value is a string. You must use an expression, and the evaluated result should be a string.

booleanValue String: 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.
doubleValue String: The asset property value is a double. You must use an expression, and the evaluated result should be a double.
integerValue String: The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
stringValue String: The asset property value is a string. You must use an expression, and the evaluated result should be a string.

AlarmModelDynamoDBv2, AlarmModelDynamoDBv2Args

TableName string: The name of the DynamoDB table.
Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload: Information needed to configure the payload. By default, ITE 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.

TableName string: The name of the DynamoDB table.
Payload AlarmModelPayload: Information needed to configure the payload. By default, ITE 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.

tableName String: The name of the DynamoDB table.
payload AlarmModelPayload: Information needed to configure the payload. By default, ITE 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.

tableName string: The name of the DynamoDB table.
payload AlarmModelPayload: Information needed to configure the payload. By default, ITE 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.

table_name str: The name of the DynamoDB table.
payload AlarmModelPayload: Information needed to configure the payload. By default, ITE 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.

tableName String: The name of the DynamoDB table.
payload Property Map: Information needed to configure the payload. By default, ITE 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.

AlarmModelDynamoDb, AlarmModelDynamoDbArgs

HashKeyField string

The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.

HashKeyValue string

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

TableName string

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

HashKeyType string

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 string

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, ITE triggers the 'INSERT' operation.

Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload

Information needed to configure the payload. By default, ITE 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.

PayloadField string

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.

RangeKeyField string

The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

RangeKeyType string

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'.

RangeKeyValue string

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

HashKeyField string

The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.

HashKeyValue string

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

TableName string

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

HashKeyType string

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 string

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, ITE triggers the 'INSERT' operation.

Payload AlarmModelPayload

PayloadField string

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.

RangeKeyField string

The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

RangeKeyType string

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'.

RangeKeyValue string

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

hashKeyField String

The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.

hashKeyValue String

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

tableName String

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

hashKeyType String

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 String

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, ITE triggers the 'INSERT' operation.

payload AlarmModelPayload

payloadField String

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.

rangeKeyField String

The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

rangeKeyType String

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'.

rangeKeyValue String

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

hashKeyField string

The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.

hashKeyValue string

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

tableName string

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

hashKeyType string

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 string

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, ITE triggers the 'INSERT' operation.

payload AlarmModelPayload

payloadField string

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.

rangeKeyField string

The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

rangeKeyType string

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'.

rangeKeyValue string

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

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 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 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, ITE triggers the 'INSERT' operation.

payload AlarmModelPayload

payload_field 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 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 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 str

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

hashKeyField String

The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.

hashKeyValue String

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

tableName String

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

hashKeyType String

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 String

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, ITE triggers the 'INSERT' operation.

payload Property Map

payloadField String

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.

rangeKeyField String

The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

rangeKeyType String

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'.

rangeKeyValue String

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

AlarmModelFirehose, AlarmModelFirehoseArgs

DeliveryStreamName string: The name of the Kinesis Data Firehose delivery stream where the data is written.
Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload: You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
Separator string: A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

DeliveryStreamName string: The name of the Kinesis Data Firehose delivery stream where the data is written.
Payload AlarmModelPayload: You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
Separator string: A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

deliveryStreamName String: The name of the Kinesis Data Firehose delivery stream where the data is written.
payload AlarmModelPayload: You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
separator String: A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

deliveryStreamName string: The name of the Kinesis Data Firehose delivery stream where the data is written.
payload AlarmModelPayload: You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
separator string: A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

delivery_stream_name str: The name of the Kinesis Data Firehose delivery stream where the data is written.
payload AlarmModelPayload: You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
separator 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), '\r\n' (Windows newline), ',' (comma).

deliveryStreamName String: The name of the Kinesis Data Firehose delivery stream where the data is written.
payload Property Map: You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
separator String: A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

AlarmModelInitializationConfiguration, AlarmModelInitializationConfigurationArgs

DisabledOnInitialization bool: 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.

DisabledOnInitialization bool: 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.

disabledOnInitialization Boolean: 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.

disabledOnInitialization boolean: 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.

disabled_on_initialization bool: 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.

disabledOnInitialization Boolean: 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.

AlarmModelIotEvents, AlarmModelIotEventsArgs

InputName string: The name of the ITE input where the data is sent.
Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload: You can configure the action payload when you send a message to an ITE input.

InputName string: The name of the ITE input where the data is sent.
Payload AlarmModelPayload: You can configure the action payload when you send a message to an ITE input.

inputName String: The name of the ITE input where the data is sent.
payload AlarmModelPayload: You can configure the action payload when you send a message to an ITE input.

inputName string: The name of the ITE input where the data is sent.
payload AlarmModelPayload: You can configure the action payload when you send a message to an ITE input.

input_name str: The name of the ITE input where the data is sent.
payload AlarmModelPayload: You can configure the action payload when you send a message to an ITE input.

inputName String: The name of the ITE input where the data is sent.
payload Property Map: You can configure the action payload when you send a message to an ITE input.

AlarmModelIotSiteWise, AlarmModelIotSiteWiseArgs

AssetId string: The ID of the asset that has the specified property.
EntryId string: 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.
PropertyAlias string: The alias of the asset property.
PropertyId string: The ID of the asset property.
PropertyValue Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAssetPropertyValue: The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

AssetId string: The ID of the asset that has the specified property.
EntryId string: 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.
PropertyAlias string: The alias of the asset property.
PropertyId string: The ID of the asset property.
PropertyValue AlarmModelAssetPropertyValue: The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

assetId String: The ID of the asset that has the specified property.
entryId String: 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.
propertyAlias String: The alias of the asset property.
propertyId String: The ID of the asset property.
propertyValue AlarmModelAssetPropertyValue: The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

assetId string: The ID of the asset that has the specified property.
entryId string: 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.
propertyAlias string: The alias of the asset property.
propertyId string: The ID of the asset property.
propertyValue AlarmModelAssetPropertyValue: The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

asset_id str: The ID of the asset that has the specified property.
entry_id 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 str: The alias of the asset property.
property_id str: The ID of the asset property.
property_value AlarmModelAssetPropertyValue: The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

assetId String: The ID of the asset that has the specified property.
entryId String: 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.
propertyAlias String: The alias of the asset property.
propertyId String: The ID of the asset property.
propertyValue Property Map: The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.

AlarmModelIotTopicPublish, AlarmModelIotTopicPublishArgs

MqttTopic string: 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 Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload: You can configure the action payload when you publish a message to an IoTCore topic.

MqttTopic string: 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 AlarmModelPayload: You can configure the action payload when you publish a message to an IoTCore topic.

mqttTopic String: 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 AlarmModelPayload: You can configure the action payload when you publish a message to an IoTCore topic.

mqttTopic string: 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 AlarmModelPayload: You can configure the action payload when you publish a message to an IoTCore topic.

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 AlarmModelPayload: You can configure the action payload when you publish a message to an IoTCore topic.

mqttTopic String: 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 Property Map: You can configure the action payload when you publish a message to an IoTCore topic.

AlarmModelLambda, AlarmModelLambdaArgs

FunctionArn string: The ARN of the Lambda function that is executed.
Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload: You can configure the action payload when you send a message to a Lambda function.

FunctionArn string: The ARN of the Lambda function that is executed.
Payload AlarmModelPayload: You can configure the action payload when you send a message to a Lambda function.

functionArn String: The ARN of the Lambda function that is executed.
payload AlarmModelPayload: You can configure the action payload when you send a message to a Lambda function.

functionArn string: The ARN of the Lambda function that is executed.
payload AlarmModelPayload: You can configure the action payload when you send a message to a Lambda function.

function_arn str: The ARN of the Lambda function that is executed.
payload AlarmModelPayload: You can configure the action payload when you send a message to a Lambda function.

functionArn String: The ARN of the Lambda function that is executed.
payload Property Map: You can configure the action payload when you send a message to a Lambda function.

AlarmModelPayload, AlarmModelPayloadArgs

ContentExpression string: 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 string: The value of the payload type can be either STRING or JSON.

ContentExpression string: 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 string: The value of the payload type can be either STRING or JSON.

contentExpression String: 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 String: The value of the payload type can be either STRING or JSON.

contentExpression string: 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 string: The value of the payload type can be either STRING or JSON.

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.

contentExpression String: 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 String: The value of the payload type can be either STRING or JSON.

AlarmModelSimpleRule, AlarmModelSimpleRuleArgs

ComparisonOperator Pulumi.AwsNative.IoTEvents.AlarmModelSimpleRuleComparisonOperator: The comparison operator.
InputProperty string: The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property.
Threshold string: The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute.

ComparisonOperator AlarmModelSimpleRuleComparisonOperator: The comparison operator.
InputProperty string: The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property.
Threshold string: The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute.

comparisonOperator AlarmModelSimpleRuleComparisonOperator: The comparison operator.
inputProperty String: The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property.
threshold String: The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute.

comparisonOperator AlarmModelSimpleRuleComparisonOperator: The comparison operator.
inputProperty string: The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property.
threshold string: The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute.

comparison_operator AlarmModelSimpleRuleComparisonOperator: The comparison operator.
input_property str: The value on the left side of the comparison operator. You can specify an ITE 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 ITE input attribute.

comparisonOperator "GREATER" | "GREATER_OR_EQUAL" | "LESS" | "LESS_OR_EQUAL" | "EQUAL" | "NOT_EQUAL": The comparison operator.
inputProperty String: The value on the left side of the comparison operator. You can specify an ITE input attribute as an input property.
threshold String: The value on the right side of the comparison operator. You can enter a number or specify an ITE input attribute.

AlarmModelSimpleRuleComparisonOperator, AlarmModelSimpleRuleComparisonOperatorArgs

Greater: GREATER
GreaterOrEqual: GREATER_OR_EQUAL
Less: LESS
LessOrEqual: LESS_OR_EQUAL
Equal: EQUAL
NotEqual: NOT_EQUAL

AlarmModelSimpleRuleComparisonOperatorGreater: GREATER
AlarmModelSimpleRuleComparisonOperatorGreaterOrEqual: GREATER_OR_EQUAL
AlarmModelSimpleRuleComparisonOperatorLess: LESS
AlarmModelSimpleRuleComparisonOperatorLessOrEqual: LESS_OR_EQUAL
AlarmModelSimpleRuleComparisonOperatorEqual: EQUAL
AlarmModelSimpleRuleComparisonOperatorNotEqual: NOT_EQUAL

Greater: GREATER
GreaterOrEqual: GREATER_OR_EQUAL
Less: LESS
LessOrEqual: LESS_OR_EQUAL
Equal: EQUAL
NotEqual: NOT_EQUAL

Greater: GREATER
GreaterOrEqual: GREATER_OR_EQUAL
Less: LESS
LessOrEqual: LESS_OR_EQUAL
Equal: EQUAL
NotEqual: NOT_EQUAL

GREATER: GREATER
GREATER_OR_EQUAL: GREATER_OR_EQUAL
LESS: LESS
LESS_OR_EQUAL: LESS_OR_EQUAL
EQUAL: EQUAL
NOT_EQUAL: NOT_EQUAL

"GREATER": GREATER
"GREATER_OR_EQUAL": GREATER_OR_EQUAL
"LESS": LESS
"LESS_OR_EQUAL": LESS_OR_EQUAL
"EQUAL": EQUAL
"NOT_EQUAL": NOT_EQUAL

AlarmModelSns, AlarmModelSnsArgs

TargetArn string: The ARN of the Amazon SNS target where the message is sent.
Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload: You can configure the action payload when you send a message as an Amazon SNS push notification.

TargetArn string: The ARN of the Amazon SNS target where the message is sent.
Payload AlarmModelPayload: You can configure the action payload when you send a message as an Amazon SNS push notification.

targetArn String: The ARN of the Amazon SNS target where the message is sent.
payload AlarmModelPayload: You can configure the action payload when you send a message as an Amazon SNS push notification.

targetArn string: The ARN of the Amazon SNS target where the message is sent.
payload AlarmModelPayload: You can configure the action payload when you send a message as an Amazon SNS push notification.

target_arn str: The ARN of the Amazon SNS target where the message is sent.
payload AlarmModelPayload: You can configure the action payload when you send a message as an Amazon SNS push notification.

targetArn String: The ARN of the Amazon SNS target where the message is sent.
payload Property Map: You can configure the action payload when you send a message as an Amazon SNS push notification.

AlarmModelSqs, AlarmModelSqsArgs

QueueUrl string: The URL of the SQS queue where the data is written.
Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload: You can configure the action payload when you send a message to an Amazon SQS queue.
UseBase64 bool: 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.

QueueUrl string: The URL of the SQS queue where the data is written.
Payload AlarmModelPayload: You can configure the action payload when you send a message to an Amazon SQS queue.
UseBase64 bool: 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.

queueUrl String: The URL of the SQS queue where the data is written.
payload AlarmModelPayload: You can configure the action payload when you send a message to an Amazon SQS queue.
useBase64 Boolean: 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.

queueUrl string: The URL of the SQS queue where the data is written.
payload AlarmModelPayload: You can configure the action payload when you send a message to an Amazon SQS queue.
useBase64 boolean: 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.

queue_url str: The URL of the SQS queue where the data is written.
payload AlarmModelPayload: You can configure the action payload when you send a message to an Amazon SQS queue.
use_base64 bool: 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.

queueUrl String: The URL of the SQS queue where the data is written.
payload Property Map: You can configure the action payload when you send a message to an Amazon SQS queue.
useBase64 Boolean: 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.

Tag, TagArgs

Key string: The key name of the tag
Value string: The value of the tag

Key string: The key name of the tag
Value string: The value of the tag

key String: The key name of the tag
value String: The value of the tag

key string: The key name of the tag
value string: The value of the tag

key str: The key name of the tag
value str: The value of the tag

key String: The key name of the tag
value String: The value of the tag

Package Details

Repository: AWS Native pulumi/pulumi-aws-native
License: Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iotevents.AlarmModel

On this page

On this page

Create AlarmModel Resource

Constructor syntax

Parameters

AlarmModel Resource Properties

Inputs

Outputs

Supporting Types

AlarmModelAcknowledgeFlow, AlarmModelAcknowledgeFlowArgs

AlarmModelAlarmAction, AlarmModelAlarmActionArgs

AlarmModelAlarmCapabilities, AlarmModelAlarmCapabilitiesArgs

AlarmModelAlarmEventActions, AlarmModelAlarmEventActionsArgs

AlarmModelAlarmRule, AlarmModelAlarmRuleArgs

AlarmModelAssetPropertyTimestamp, AlarmModelAssetPropertyTimestampArgs

AlarmModelAssetPropertyValue, AlarmModelAssetPropertyValueArgs

AlarmModelAssetPropertyVariant, AlarmModelAssetPropertyVariantArgs

AlarmModelDynamoDBv2, AlarmModelDynamoDBv2Args

AlarmModelDynamoDb, AlarmModelDynamoDbArgs

AlarmModelFirehose, AlarmModelFirehoseArgs

AlarmModelInitializationConfiguration, AlarmModelInitializationConfigurationArgs

AlarmModelIotEvents, AlarmModelIotEventsArgs

AlarmModelIotSiteWise, AlarmModelIotSiteWiseArgs

AlarmModelIotTopicPublish, AlarmModelIotTopicPublishArgs

AlarmModelLambda, AlarmModelLambdaArgs

AlarmModelPayload, AlarmModelPayloadArgs

AlarmModelSimpleRule, AlarmModelSimpleRuleArgs

AlarmModelSimpleRuleComparisonOperator, AlarmModelSimpleRuleComparisonOperatorArgs

AlarmModelSns, AlarmModelSnsArgs

AlarmModelSqs, AlarmModelSqsArgs

Tag, TagArgs

Package Details

On this page

On this page