AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

DetectorModel

The AWS::IoTEvents::DetectorModel resource creates a detector model. You create a detector model (a model of your equipment or process) using states. For each state, you define conditional (Boolean) logic that evaluates the incoming inputs to detect significant events. When an event is detected, it can change the state or trigger custom-built or predefined actions using other AWS services. You can define additional events that trigger actions when entering or exiting a state and, optionally, when a condition is met. For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide.

Create a DetectorModel Resource

new DetectorModel(name: string, args: DetectorModelArgs, opts?: CustomResourceOptions);
@overload
def DetectorModel(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  detector_model_definition: Optional[DetectorModelDefinitionArgs] = None,
                  detector_model_description: Optional[str] = None,
                  detector_model_name: Optional[str] = None,
                  evaluation_method: Optional[DetectorModelEvaluationMethod] = None,
                  key: Optional[str] = None,
                  role_arn: Optional[str] = None,
                  tags: Optional[Sequence[DetectorModelTagArgs]] = None)
@overload
def DetectorModel(resource_name: str,
                  args: DetectorModelArgs,
                  opts: Optional[ResourceOptions] = None)
func NewDetectorModel(ctx *Context, name string, args DetectorModelArgs, opts ...ResourceOption) (*DetectorModel, error)
public DetectorModel(string name, DetectorModelArgs args, CustomResourceOptions? opts = null)
public DetectorModel(String name, DetectorModelArgs args)
public DetectorModel(String name, DetectorModelArgs args, CustomResourceOptions options)
type: aws-native:iotevents:DetectorModel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DetectorModelArgs
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 DetectorModelArgs
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 DetectorModelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DetectorModelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DetectorModelArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DetectorModel 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 DetectorModel resource accepts the following input properties:

DetectorModelDefinition Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelDefinitionArgs
RoleArn string

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

DetectorModelDescription string

A brief description of the detector model.

DetectorModelName string

The name of the detector model.

EvaluationMethod Pulumi.AwsNative.IoTEvents.DetectorModelEvaluationMethod

Information about the order in which events are evaluated and how actions are executed.

Key string

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector 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 detector instance, the device must send a message payload that contains the same attribute-value.

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

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

For more information, see Tag.

DetectorModelDefinition DetectorModelDefinitionArgs
RoleArn string

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

DetectorModelDescription string

A brief description of the detector model.

DetectorModelName string

The name of the detector model.

EvaluationMethod DetectorModelEvaluationMethod

Information about the order in which events are evaluated and how actions are executed.

Key string

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector 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 detector instance, the device must send a message payload that contains the same attribute-value.

Tags []DetectorModelTagArgs

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

For more information, see Tag.

detectorModelDefinition DetectorModelDefinitionArgs
roleArn String

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

detectorModelDescription String

A brief description of the detector model.

detectorModelName String

The name of the detector model.

evaluationMethod DetectorModelEvaluationMethod

Information about the order in which events are evaluated and how actions are executed.

key String

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector 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 detector instance, the device must send a message payload that contains the same attribute-value.

tags List<DetectorModelTagArgs>

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

For more information, see Tag.

detectorModelDefinition DetectorModelDefinitionArgs
roleArn string

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

detectorModelDescription string

A brief description of the detector model.

detectorModelName string

The name of the detector model.

evaluationMethod DetectorModelEvaluationMethod

Information about the order in which events are evaluated and how actions are executed.

key string

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector 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 detector instance, the device must send a message payload that contains the same attribute-value.

tags DetectorModelTagArgs[]

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

For more information, see Tag.

detector_model_definition DetectorModelDefinitionArgs
role_arn str

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

detector_model_description str

A brief description of the detector model.

detector_model_name str

The name of the detector model.

evaluation_method DetectorModelEvaluationMethod

Information about the order in which events are evaluated and how actions are executed.

key str

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector 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 detector instance, the device must send a message payload that contains the same attribute-value.

tags Sequence[DetectorModelTagArgs]

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

For more information, see Tag.

detectorModelDefinition Property Map
roleArn String

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

detectorModelDescription String

A brief description of the detector model.

detectorModelName String

The name of the detector model.

evaluationMethod "BATCH" | "SERIAL"

Information about the order in which events are evaluated and how actions are executed.

key String

The value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. AWS IoT Events can continue to route input to its corresponding detector 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 detector instance, the device must send a message payload that contains the same attribute-value.

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

DetectorModelAction

ClearTimer Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelClearTimer
DynamoDB Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelDynamoDB
DynamoDBv2 Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelDynamoDBv2
Firehose Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelFirehose
IotEvents Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelIotEvents
IotSiteWise Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelIotSiteWise
IotTopicPublish Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelIotTopicPublish
Lambda Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelLambda
ResetTimer Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelResetTimer
SetTimer Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelSetTimer
SetVariable Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelSetVariable
Sns Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelSns
Sqs Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelSqs

DetectorModelAssetPropertyTimestamp

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.

DetectorModelAssetPropertyValue

Value Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelAssetPropertyVariant
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.DetectorModelAssetPropertyTimestamp
Value DetectorModelAssetPropertyVariant
Quality string

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

Timestamp DetectorModelAssetPropertyTimestamp
value DetectorModelAssetPropertyVariant
quality String

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

timestamp DetectorModelAssetPropertyTimestamp
value DetectorModelAssetPropertyVariant
quality string

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

timestamp DetectorModelAssetPropertyTimestamp
value DetectorModelAssetPropertyVariant
quality str

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

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

DetectorModelAssetPropertyVariant

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.

DetectorModelClearTimer

TimerName string
TimerName string
timerName String
timerName string
timerName String

DetectorModelDefinition

InitialStateName string

The state that is entered at the creation of each detector (instance).

States List<Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelState>

Information about the states of the detector.

InitialStateName string

The state that is entered at the creation of each detector (instance).

States []DetectorModelStateType

Information about the states of the detector.

initialStateName String

The state that is entered at the creation of each detector (instance).

states List<DetectorModelState>

Information about the states of the detector.

initialStateName string

The state that is entered at the creation of each detector (instance).

states DetectorModelState[]

Information about the states of the detector.

initial_state_name str

The state that is entered at the creation of each detector (instance).

states Sequence[DetectorModelState]

Information about the states of the detector.

initialStateName String

The state that is entered at the creation of each detector (instance).

states List<Property Map>

Information about the states of the detector.

DetectorModelDynamoDB

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

DetectorModelDynamoDBv2

TableName string

The name of the DynamoDB table.

Payload DetectorModelPayload
tableName String

The name of the DynamoDB table.

payload DetectorModelPayload
tableName string

The name of the DynamoDB table.

payload DetectorModelPayload
table_name str

The name of the DynamoDB table.

payload DetectorModelPayload
tableName String

The name of the DynamoDB table.

payload Property Map

DetectorModelEvaluationMethod

Batch
BATCH
Serial
SERIAL
DetectorModelEvaluationMethodBatch
BATCH
DetectorModelEvaluationMethodSerial
SERIAL
Batch
BATCH
Serial
SERIAL
Batch
BATCH
Serial
SERIAL
BATCH
BATCH
SERIAL
SERIAL
"BATCH"
BATCH
"SERIAL"
SERIAL

DetectorModelEvent

EventName string

The name of the event.

Actions List<Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelAction>

The actions to be performed.

Condition string

The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).

EventName string

The name of the event.

Actions []DetectorModelAction

The actions to be performed.

Condition string

The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).

eventName String

The name of the event.

actions List<DetectorModelAction>

The actions to be performed.

condition String

The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).

eventName string

The name of the event.

actions DetectorModelAction[]

The actions to be performed.

condition string

The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).

event_name str

The name of the event.

actions Sequence[DetectorModelAction]

The actions to be performed.

condition str

The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).

eventName String

The name of the event.

actions List<Property Map>

The actions to be performed.

condition String

The Boolean expression that, when TRUE, causes the actions to be performed. If not present, the actions are performed (=TRUE). If the expression result is not a Boolean value, the actions are not performed (=FALSE).

DetectorModelFirehose

DeliveryStreamName string

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

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

DetectorModelIotEvents

InputName string

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

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

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

Payload DetectorModelPayload
inputName String

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

payload DetectorModelPayload
inputName string

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

payload DetectorModelPayload
input_name str

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

payload DetectorModelPayload
inputName String

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

payload Property Map

DetectorModelIotSiteWise

PropertyValue Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelAssetPropertyValue
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 DetectorModelAssetPropertyValue
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 DetectorModelAssetPropertyValue
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 DetectorModelAssetPropertyValue
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.

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

propertyValue Property Map
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.

DetectorModelIotTopicPublish

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

DetectorModelLambda

FunctionArn string

The ARN of the Lambda function that is executed.

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

The ARN of the Lambda function that is executed.

Payload DetectorModelPayload
functionArn String

The ARN of the Lambda function that is executed.

payload DetectorModelPayload
functionArn string

The ARN of the Lambda function that is executed.

payload DetectorModelPayload
function_arn str

The ARN of the Lambda function that is executed.

payload DetectorModelPayload
functionArn String

The ARN of the Lambda function that is executed.

payload Property Map

DetectorModelOnEnter

Events List<Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelEvent>

Specifies the actions that are performed when the state is entered and the condition is TRUE.

Events []DetectorModelEvent

Specifies the actions that are performed when the state is entered and the condition is TRUE.

events List<DetectorModelEvent>

Specifies the actions that are performed when the state is entered and the condition is TRUE.

events DetectorModelEvent[]

Specifies the actions that are performed when the state is entered and the condition is TRUE.

events Sequence[DetectorModelEvent]

Specifies the actions that are performed when the state is entered and the condition is TRUE.

events List<Property Map>

Specifies the actions that are performed when the state is entered and the condition is TRUE.

DetectorModelOnExit

Events List<Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelEvent>

Specifies the actions that are performed when the state is exited and the condition is TRUE.

Events []DetectorModelEvent

Specifies the actions that are performed when the state is exited and the condition is TRUE.

events List<DetectorModelEvent>

Specifies the actions that are performed when the state is exited and the condition is TRUE.

events DetectorModelEvent[]

Specifies the actions that are performed when the state is exited and the condition is TRUE.

events Sequence[DetectorModelEvent]

Specifies the actions that are performed when the state is exited and the condition is TRUE.

events List<Property Map>

Specifies the actions that are performed when the state is exited and the condition is TRUE.

DetectorModelOnInput

Events List<Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelEvent>

Specifies the actions performed when the condition evaluates to TRUE.

TransitionEvents List<Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelTransitionEvent>

Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.

Events []DetectorModelEvent

Specifies the actions performed when the condition evaluates to TRUE.

TransitionEvents []DetectorModelTransitionEvent

Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.

events List<DetectorModelEvent>

Specifies the actions performed when the condition evaluates to TRUE.

transitionEvents List<DetectorModelTransitionEvent>

Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.

events DetectorModelEvent[]

Specifies the actions performed when the condition evaluates to TRUE.

transitionEvents DetectorModelTransitionEvent[]

Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.

events Sequence[DetectorModelEvent]

Specifies the actions performed when the condition evaluates to TRUE.

transition_events Sequence[DetectorModelTransitionEvent]

Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.

events List<Property Map>

Specifies the actions performed when the condition evaluates to TRUE.

transitionEvents List<Property Map>

Specifies the actions performed, and the next state entered, when a condition evaluates to TRUE.

DetectorModelPayload

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.

DetectorModelResetTimer

TimerName string

The name of the timer to reset.

TimerName string

The name of the timer to reset.

timerName String

The name of the timer to reset.

timerName string

The name of the timer to reset.

timer_name str

The name of the timer to reset.

timerName String

The name of the timer to reset.

DetectorModelSetTimer

TimerName string

The name of the timer.

DurationExpression string

The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.

Seconds int

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.

TimerName string

The name of the timer.

DurationExpression string

The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.

Seconds int

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.

timerName String

The name of the timer.

durationExpression String

The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.

seconds Integer

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.

timerName string

The name of the timer.

durationExpression string

The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.

seconds number

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.

timer_name str

The name of the timer.

duration_expression str

The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.

seconds int

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.

timerName String

The name of the timer.

durationExpression String

The duration of the timer, in seconds. You can use a string expression that includes numbers, variables ($variable.<variable-name>), and input values ($input.<input-name>.<path-to-datum>) as the duration. The range of the duration is 1-31622400 seconds. To ensure accuracy, the minimum duration is 60 seconds. The evaluated result of the duration is rounded down to the nearest whole number.

seconds Number

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy. The maximum value is 31622400 seconds.

DetectorModelSetVariable

Value string

The new value of the variable.

VariableName string

The name of the variable.

Value string

The new value of the variable.

VariableName string

The name of the variable.

value String

The new value of the variable.

variableName String

The name of the variable.

value string

The new value of the variable.

variableName string

The name of the variable.

value str

The new value of the variable.

variable_name str

The name of the variable.

value String

The new value of the variable.

variableName String

The name of the variable.

DetectorModelSns

TargetArn string

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

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

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

Payload DetectorModelPayload
targetArn String

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

payload DetectorModelPayload
targetArn string

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

payload DetectorModelPayload
target_arn str

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

payload DetectorModelPayload
targetArn String

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

payload Property Map

DetectorModelSqs

QueueUrl string

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

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

DetectorModelState

DetectorModelTag

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.

DetectorModelTransitionEvent

Condition string

A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.

EventName string

The name of the event.

NextState string

The next state to enter.

Actions List<Pulumi.AwsNative.IoTEvents.Inputs.DetectorModelAction>

The actions to be performed.

Condition string

A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.

EventName string

The name of the event.

NextState string

The next state to enter.

Actions []DetectorModelAction

The actions to be performed.

condition String

A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.

eventName String

The name of the event.

nextState String

The next state to enter.

actions List<DetectorModelAction>

The actions to be performed.

condition string

A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.

eventName string

The name of the event.

nextState string

The next state to enter.

actions DetectorModelAction[]

The actions to be performed.

condition str

A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.

event_name str

The name of the event.

next_state str

The next state to enter.

actions Sequence[DetectorModelAction]

The actions to be performed.

condition String

A Boolean expression that when TRUE causes the actions to be performed and the nextState to be entered.

eventName String

The name of the event.

nextState String

The next state to enter.

actions List<Property Map>

The actions to be performed.

Package Details

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