AWS Native

v0.29.0 published on Thursday, Sep 8, 2022 by Pulumi

AlarmModel

The AWS::IoTEvents::AlarmModel resource creates a alarm model. AWS IoT Events alarms help you monitor your data for changes. The data can be metrics that you measure for your equipment and processes. You can create alarms that send notifications when a threshold is breached. Alarms help you detect issues, streamline maintenance, and optimize performance of your equipment and processes.

Alarms are instances of alarm models. The alarm model specifies what to detect, when to send notifications, who gets notified, and more. You can also specify one or more supported actions that occur when the alarm state changes. AWS IoT Events routes input attributes derived from your data to the appropriate alarms. If the data that you’re monitoring is outside the specified range, the alarm is invoked. You can also acknowledge the alarms or set them to the snooze mode.

Create a AlarmModel Resource

new AlarmModel(name: string, args: AlarmModelArgs, opts?: CustomResourceOptions);
@overload
def AlarmModel(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               alarm_capabilities: Optional[AlarmModelAlarmCapabilitiesArgs] = None,
               alarm_event_actions: Optional[AlarmModelAlarmEventActionsArgs] = None,
               alarm_model_description: Optional[str] = None,
               alarm_model_name: Optional[str] = None,
               alarm_rule: Optional[AlarmModelAlarmRuleArgs] = None,
               key: Optional[str] = None,
               role_arn: Optional[str] = None,
               severity: Optional[int] = None,
               tags: Optional[Sequence[AlarmModelTagArgs]] = None)
@overload
def AlarmModel(resource_name: str,
               args: AlarmModelArgs,
               opts: Optional[ResourceOptions] = 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.

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

The AlarmModel resource accepts the following input properties:

AlarmRule Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAlarmRuleArgs
RoleArn string

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

AlarmCapabilities Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAlarmCapabilitiesArgs
AlarmEventActions Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAlarmEventActionsArgs
AlarmModelDescription string

A brief description of the alarm model.

AlarmModelName string

The name of the alarm model.

Key string

The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.

Severity int

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

Tags List<Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelTagArgs>

An array of key-value pairs to apply to this resource.

For more information, see Tag.

AlarmRule AlarmModelAlarmRuleArgs
RoleArn string

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

AlarmCapabilities AlarmModelAlarmCapabilitiesArgs
AlarmEventActions AlarmModelAlarmEventActionsArgs
AlarmModelDescription string

A brief description of the alarm model.

AlarmModelName string

The name of the alarm model.

Key string

The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.

Severity int

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

Tags []AlarmModelTagArgs

An array of key-value pairs to apply to this resource.

For more information, see Tag.

alarmRule AlarmModelAlarmRuleArgs
roleArn String

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

alarmCapabilities AlarmModelAlarmCapabilitiesArgs
alarmEventActions AlarmModelAlarmEventActionsArgs
alarmModelDescription String

A brief description of the alarm model.

alarmModelName String

The name of the alarm model.

key String

The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.

severity Integer

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

tags List<AlarmModelTagArgs>

An array of key-value pairs to apply to this resource.

For more information, see Tag.

alarmRule AlarmModelAlarmRuleArgs
roleArn string

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

alarmCapabilities AlarmModelAlarmCapabilitiesArgs
alarmEventActions AlarmModelAlarmEventActionsArgs
alarmModelDescription string

A brief description of the alarm model.

alarmModelName string

The name of the alarm model.

key string

The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.

severity number

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

tags AlarmModelTagArgs[]

An array of key-value pairs to apply to this resource.

For more information, see Tag.

alarm_rule AlarmModelAlarmRuleArgs
role_arn str

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

alarm_capabilities AlarmModelAlarmCapabilitiesArgs
alarm_event_actions AlarmModelAlarmEventActionsArgs
alarm_model_description str

A brief description of the alarm model.

alarm_model_name str

The name of the alarm model.

key str

The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.

severity int

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

tags Sequence[AlarmModelTagArgs]

An array of key-value pairs to apply to this resource.

For more information, see Tag.

alarmRule Property Map
roleArn String

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

alarmCapabilities Property Map
alarmEventActions Property Map
alarmModelDescription String

A brief description of the alarm model.

alarmModelName String

The name of the alarm model.

key String

The value used to identify a alarm instance. When a device or system sends input, a new alarm instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding alarm instance based on this identifying information.

This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct alarm instance, the device must send a message payload that contains the same attribute-value.

severity Number

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

tags List<Property Map>

An array of key-value pairs to apply to this resource.

For more information, see Tag.

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

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

AlarmModelAlarmCapabilities

AlarmModelAlarmEventActions

AlarmModelAlarmRule

AlarmModelAssetPropertyTimestamp

TimeInSeconds string

The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.

OffsetInNanos string

The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.

TimeInSeconds string

The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.

OffsetInNanos string

The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.

timeInSeconds String

The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.

offsetInNanos String

The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.

timeInSeconds string

The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.

offsetInNanos string

The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.

time_in_seconds str

The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.

offset_in_nanos str

The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.

timeInSeconds String

The nanosecond offset converted from timeInSeconds. The valid range is between 0-999999999. You can also specify an expression.

offsetInNanos String

The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.

AlarmModelAssetPropertyValue

Value Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAssetPropertyVariant
Quality string

The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.

Timestamp Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAssetPropertyTimestamp
Value AlarmModelAssetPropertyVariant
Quality string

The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.

Timestamp AlarmModelAssetPropertyTimestamp
value AlarmModelAssetPropertyVariant
quality String

The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.

timestamp AlarmModelAssetPropertyTimestamp
value AlarmModelAssetPropertyVariant
quality string

The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.

timestamp AlarmModelAssetPropertyTimestamp
value AlarmModelAssetPropertyVariant
quality str

The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.

timestamp AlarmModelAssetPropertyTimestamp
value Property Map
quality String

The quality of the asset property value. The value must be GOOD, BAD, or UNCERTAIN. You can also specify an expression.

timestamp Property Map

AlarmModelAssetPropertyVariant

BooleanValue string

The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.

DoubleValue string

The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.

IntegerValue string

The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.

StringValue string

The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.

BooleanValue string

The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.

DoubleValue string

The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.

IntegerValue string

The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.

StringValue string

The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.

booleanValue String

The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.

doubleValue String

The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.

integerValue String

The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.

stringValue String

The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.

booleanValue string

The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.

doubleValue string

The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.

integerValue string

The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.

stringValue string

The asset property value is a string. You can also specify an expression. If you use an expression, 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 can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.

double_value str

The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.

integer_value str

The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.

string_value str

The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.

booleanValue String

The asset property value is a Boolean value that must be TRUE or FALSE. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.

doubleValue String

The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.

integerValue String

The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.

stringValue String

The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.

AlarmModelDynamoDB

HashKeyField string

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

HashKeyValue string

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

TableName string

The name of the 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, AWS IoT Events triggers the INSERT operation.

Payload Pulumi.AwsNative.IoTEvents.Inputs.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).

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

HashKeyValue string

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

TableName string

The name of the 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, AWS IoT Events 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).

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

hashKeyValue String

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

tableName String

The name of the 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, AWS IoT Events 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).

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

hashKeyValue string

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

tableName string

The name of the 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, AWS IoT Events 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).

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

hash_key_value str

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

table_name str

The name of the 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, AWS IoT Events 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).

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

hashKeyValue String

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

tableName String

The name of the 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, AWS IoT Events 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).

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

AlarmModelDynamoDBv2

TableName string

The name of the DynamoDB table.

Payload AlarmModelPayload
tableName String

The name of the DynamoDB table.

payload AlarmModelPayload
tableName string

The name of the DynamoDB table.

payload AlarmModelPayload
table_name str

The name of the DynamoDB table.

payload AlarmModelPayload
tableName String

The name of the DynamoDB table.

payload Property Map

AlarmModelFirehose

DeliveryStreamName string

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

Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload
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
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
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
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
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
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

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

InputName string

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

Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload
InputName string

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

Payload AlarmModelPayload
inputName String

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

payload AlarmModelPayload
inputName string

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

payload AlarmModelPayload
input_name str

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

payload AlarmModelPayload
inputName String

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

payload Property Map

AlarmModelIotSiteWise

AssetId string

The ID of the asset that has the specified property. You can specify an expression.

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. You can also specify an expression.

PropertyAlias string

The alias of the asset property. You can also specify an expression.

PropertyId string

The ID of the asset property. You can specify an expression.

PropertyValue Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelAssetPropertyValue
AssetId string

The ID of the asset that has the specified property. You can specify an expression.

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. You can also specify an expression.

PropertyAlias string

The alias of the asset property. You can also specify an expression.

PropertyId string

The ID of the asset property. You can specify an expression.

PropertyValue AlarmModelAssetPropertyValue
assetId String

The ID of the asset that has the specified property. You can specify an expression.

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. You can also specify an expression.

propertyAlias String

The alias of the asset property. You can also specify an expression.

propertyId String

The ID of the asset property. You can specify an expression.

propertyValue AlarmModelAssetPropertyValue
assetId string

The ID of the asset that has the specified property. You can specify an expression.

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. You can also specify an expression.

propertyAlias string

The alias of the asset property. You can also specify an expression.

propertyId string

The ID of the asset property. You can specify an expression.

propertyValue AlarmModelAssetPropertyValue
asset_id str

The ID of the asset that has the specified property. You can specify an expression.

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. You can also specify an expression.

property_alias str

The alias of the asset property. You can also specify an expression.

property_id str

The ID of the asset property. You can specify an expression.

property_value AlarmModelAssetPropertyValue
assetId String

The ID of the asset that has the specified property. You can specify an expression.

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. You can also specify an expression.

propertyAlias String

The alias of the asset property. You can also specify an expression.

propertyId String

The ID of the asset property. You can specify an expression.

propertyValue Property Map

AlarmModelIotTopicPublish

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

AlarmModelLambda

FunctionArn string

The ARN of the Lambda function that is executed.

Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload
FunctionArn string

The ARN of the Lambda function that is executed.

Payload AlarmModelPayload
functionArn String

The ARN of the Lambda function that is executed.

payload AlarmModelPayload
functionArn string

The ARN of the Lambda function that is executed.

payload AlarmModelPayload
function_arn str

The ARN of the Lambda function that is executed.

payload AlarmModelPayload
functionArn String

The ARN of the Lambda function that is executed.

payload Property Map

AlarmModelPayload

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

ComparisonOperator Pulumi.AwsNative.IoTEvents.AlarmModelSimpleRuleComparisonOperator

The comparison operator.

InputProperty string

The value on the left side of the comparison operator. You can specify an AWS IoT Events 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 AWS IoT Events input attribute.

ComparisonOperator AlarmModelSimpleRuleComparisonOperator

The comparison operator.

InputProperty string

The value on the left side of the comparison operator. You can specify an AWS IoT Events 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 AWS IoT Events input attribute.

comparisonOperator AlarmModelSimpleRuleComparisonOperator

The comparison operator.

inputProperty String

The value on the left side of the comparison operator. You can specify an AWS IoT Events 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 AWS IoT Events input attribute.

comparisonOperator AlarmModelSimpleRuleComparisonOperator

The comparison operator.

inputProperty string

The value on the left side of the comparison operator. You can specify an AWS IoT Events 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 AWS IoT Events 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 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.

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 AWS IoT Events 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 AWS IoT Events input attribute.

AlarmModelSimpleRuleComparisonOperator

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

TargetArn string

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

Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload
TargetArn string

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

Payload AlarmModelPayload
targetArn String

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

payload AlarmModelPayload
targetArn string

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

payload AlarmModelPayload
target_arn str

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

payload AlarmModelPayload
targetArn String

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

payload Property Map

AlarmModelSqs

QueueUrl string

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

Payload Pulumi.AwsNative.IoTEvents.Inputs.AlarmModelPayload
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
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
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
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
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
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.

AlarmModelTag

Key string

Key of the Tag.

Value string

Value of the Tag.

Key string

Key of the Tag.

Value string

Value of the Tag.

key String

Key of the Tag.

value String

Value of the Tag.

key string

Key of the Tag.

value string

Value of the Tag.

key str

Key of the Tag.

value str

Value of the Tag.

key String

Key of the Tag.

value String

Value of the Tag.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0