1. Packages
  2. AWS Native
  3. API Docs
  4. iotevents
  5. getAlarmModel

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.iotevents.getAlarmModel

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    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.

    Using getAlarmModel

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAlarmModel(args: GetAlarmModelArgs, opts?: InvokeOptions): Promise<GetAlarmModelResult>
    function getAlarmModelOutput(args: GetAlarmModelOutputArgs, opts?: InvokeOptions): Output<GetAlarmModelResult>
    def get_alarm_model(alarm_model_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetAlarmModelResult
    def get_alarm_model_output(alarm_model_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetAlarmModelResult]
    func LookupAlarmModel(ctx *Context, args *LookupAlarmModelArgs, opts ...InvokeOption) (*LookupAlarmModelResult, error)
    func LookupAlarmModelOutput(ctx *Context, args *LookupAlarmModelOutputArgs, opts ...InvokeOption) LookupAlarmModelResultOutput

    > Note: This function is named LookupAlarmModel in the Go SDK.

    public static class GetAlarmModel 
    {
        public static Task<GetAlarmModelResult> InvokeAsync(GetAlarmModelArgs args, InvokeOptions? opts = null)
        public static Output<GetAlarmModelResult> Invoke(GetAlarmModelInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAlarmModelResult> getAlarmModel(GetAlarmModelArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:iotevents:getAlarmModel
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AlarmModelName string
    The name of the alarm model.
    AlarmModelName string
    The name of the alarm model.
    alarmModelName String
    The name of the alarm model.
    alarmModelName string
    The name of the alarm model.
    alarm_model_name str
    The name of the alarm model.
    alarmModelName String
    The name of the alarm model.

    getAlarmModel Result

    The following output properties are available:

    AlarmCapabilities Pulumi.AwsNative.IoTEvents.Outputs.AlarmModelAlarmCapabilities
    Contains the configuration information of alarm state changes.
    AlarmEventActions Pulumi.AwsNative.IoTEvents.Outputs.AlarmModelAlarmEventActions
    Contains information about one or more alarm actions.
    AlarmModelDescription string
    A brief description of the alarm model.
    AlarmRule Pulumi.AwsNative.IoTEvents.Outputs.AlarmModelAlarmRule
    Defines when your alarm is invoked.
    RoleArn string
    The ARN of the role that grants permission to AWS IoT Events to perform its operations.
    Severity int
    A non-negative integer that reflects the severity level of the alarm.
    Tags List<Pulumi.AwsNative.Outputs.Tag>

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

    For more information, see Tag.

    AlarmCapabilities AlarmModelAlarmCapabilities
    Contains the configuration information of alarm state changes.
    AlarmEventActions AlarmModelAlarmEventActions
    Contains information about one or more alarm actions.
    AlarmModelDescription string
    A brief description of the alarm model.
    AlarmRule AlarmModelAlarmRule
    Defines when your alarm is invoked.
    RoleArn string
    The ARN of the role that grants permission to AWS IoT Events to perform its operations.
    Severity int
    A non-negative integer that reflects the severity level of the alarm.
    Tags Tag

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

    For more information, see Tag.

    alarmCapabilities AlarmModelAlarmCapabilities
    Contains the configuration information of alarm state changes.
    alarmEventActions AlarmModelAlarmEventActions
    Contains information about one or more alarm actions.
    alarmModelDescription String
    A brief description of the alarm model.
    alarmRule AlarmModelAlarmRule
    Defines when your alarm is invoked.
    roleArn String
    The ARN of the role that grants permission to AWS IoT Events to perform its operations.
    severity Integer
    A non-negative integer that reflects the severity level of the alarm.
    tags List<Tag>

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

    For more information, see Tag.

    alarmCapabilities AlarmModelAlarmCapabilities
    Contains the configuration information of alarm state changes.
    alarmEventActions AlarmModelAlarmEventActions
    Contains information about one or more alarm actions.
    alarmModelDescription string
    A brief description of the alarm model.
    alarmRule AlarmModelAlarmRule
    Defines when your alarm is invoked.
    roleArn string
    The ARN of the role that grants permission to AWS IoT Events to perform its operations.
    severity number
    A non-negative integer that reflects the severity level of the alarm.
    tags Tag[]

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

    For more information, see Tag.

    alarm_capabilities AlarmModelAlarmCapabilities
    Contains the configuration information of alarm state changes.
    alarm_event_actions AlarmModelAlarmEventActions
    Contains information about one or more alarm actions.
    alarm_model_description str
    A brief description of the alarm model.
    alarm_rule AlarmModelAlarmRule
    Defines when your alarm is invoked.
    role_arn str
    The ARN of the role that grants permission to AWS IoT Events to perform its operations.
    severity int
    A non-negative integer that reflects the severity level of the alarm.
    tags Sequence[root_Tag]

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

    For more information, see Tag.

    alarmCapabilities Property Map
    Contains the configuration information of alarm state changes.
    alarmEventActions Property Map
    Contains information about one or more alarm actions.
    alarmModelDescription String
    A brief description of the alarm model.
    alarmRule Property Map
    Defines when your alarm is invoked.
    roleArn String
    The ARN of the role that grants permission to AWS IoT Events to perform its operations.
    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.

    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

    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

    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

    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

    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.

    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

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

    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

    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.

    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 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
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi