We recommend new projects start with resources from the AWS provider.
aws-native.iot.getTopicRule
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::IoT::TopicRule
Using getTopicRule
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 getTopicRule(args: GetTopicRuleArgs, opts?: InvokeOptions): Promise<GetTopicRuleResult>
function getTopicRuleOutput(args: GetTopicRuleOutputArgs, opts?: InvokeOptions): Output<GetTopicRuleResult>
def get_topic_rule(rule_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTopicRuleResult
def get_topic_rule_output(rule_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTopicRuleResult]
func LookupTopicRule(ctx *Context, args *LookupTopicRuleArgs, opts ...InvokeOption) (*LookupTopicRuleResult, error)
func LookupTopicRuleOutput(ctx *Context, args *LookupTopicRuleOutputArgs, opts ...InvokeOption) LookupTopicRuleResultOutput
> Note: This function is named LookupTopicRule
in the Go SDK.
public static class GetTopicRule
{
public static Task<GetTopicRuleResult> InvokeAsync(GetTopicRuleArgs args, InvokeOptions? opts = null)
public static Output<GetTopicRuleResult> Invoke(GetTopicRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTopicRuleResult> getTopicRule(GetTopicRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:iot:getTopicRule
arguments:
# arguments dictionary
The following arguments are supported:
- Rule
Name string The name of the rule.
Pattern :
^[a-zA-Z0-9_]+$
- Rule
Name string The name of the rule.
Pattern :
^[a-zA-Z0-9_]+$
- rule
Name String The name of the rule.
Pattern :
^[a-zA-Z0-9_]+$
- rule
Name string The name of the rule.
Pattern :
^[a-zA-Z0-9_]+$
- rule_
name str The name of the rule.
Pattern :
^[a-zA-Z0-9_]+$
- rule
Name String The name of the rule.
Pattern :
^[a-zA-Z0-9_]+$
getTopicRule Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) of the AWS IoT rule, such as
arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule
. - List<Pulumi.
Aws Native. Outputs. Tag> Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
- Topic
Rule Pulumi.Payload Aws Native. Io T. Outputs. Topic Rule Payload - The rule payload.
- Arn string
- The Amazon Resource Name (ARN) of the AWS IoT rule, such as
arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule
. - Tag
Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
- Topic
Rule TopicPayload Rule Payload - The rule payload.
- arn String
- The Amazon Resource Name (ARN) of the AWS IoT rule, such as
arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule
. - List<Tag>
Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
- topic
Rule TopicPayload Rule Payload - The rule payload.
- arn string
- The Amazon Resource Name (ARN) of the AWS IoT rule, such as
arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule
. - Tag[]
Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
- topic
Rule TopicPayload Rule Payload - The rule payload.
- arn str
- The Amazon Resource Name (ARN) of the AWS IoT rule, such as
arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule
. - Sequence[root_Tag]
Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
- topic_
rule_ Topicpayload Rule Payload - The rule payload.
- arn String
- The Amazon Resource Name (ARN) of the AWS IoT rule, such as
arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule
. - List<Property Map>
Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
- topic
Rule Property MapPayload - The rule payload.
Supporting Types
Tag
TopicRuleAction
- Cloudwatch
Alarm Pulumi.Aws Native. Io T. Inputs. Topic Rule Cloudwatch Alarm Action - Change the state of a CloudWatch alarm.
- Cloudwatch
Logs Pulumi.Aws Native. Io T. Inputs. Topic Rule Cloudwatch Logs Action - Sends data to CloudWatch.
- Cloudwatch
Metric Pulumi.Aws Native. Io T. Inputs. Topic Rule Cloudwatch Metric Action - Capture a CloudWatch metric.
- Dynamo
DBv2 Pulumi.Aws Native. Io T. Inputs. Topic Rule Dynamo DBv2Action - Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
- Dynamo
Db Pulumi.Aws Native. Io T. Inputs. Topic Rule Dynamo Db Action - Write to a DynamoDB table.
- Elasticsearch
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Elasticsearch Action Write data to an Amazon OpenSearch Service domain.
The
Elasticsearch
action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use theOpenSearch
rule action instead. For more information, see OpenSearchAction .- Firehose
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Firehose Action - Write to an Amazon Kinesis Firehose stream.
- Http
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Http Action - Send data to an HTTPS endpoint.
- Iot
Analytics Pulumi.Aws Native. Io T. Inputs. Topic Rule Iot Analytics Action - Sends message data to an AWS IoT Analytics channel.
- Iot
Events Pulumi.Aws Native. Io T. Inputs. Topic Rule Iot Events Action - Sends an input to an AWS IoT Events detector.
- Iot
Site Pulumi.Wise Aws Native. Io T. Inputs. Topic Rule Iot Site Wise Action - Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
- Kafka
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Kafka Action - Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
- Kinesis
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Kinesis Action - Write data to an Amazon Kinesis stream.
- Lambda
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Lambda Action - Invoke a Lambda function.
- Location
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Location Action - Sends device location data to Amazon Location Service .
- Open
Search Pulumi.Aws Native. Io T. Inputs. Topic Rule Open Search Action - Write data to an Amazon OpenSearch Service domain.
- Republish
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Republish Action - Publish to another MQTT topic.
- S3
Pulumi.
Aws Native. Io T. Inputs. Topic Rule S3Action - Write to an Amazon S3 bucket.
- Sns
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Sns Action - Publish to an Amazon SNS topic.
- Sqs
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Sqs Action - Publish to an Amazon SQS queue.
- Step
Functions Pulumi.Aws Native. Io T. Inputs. Topic Rule Step Functions Action - Starts execution of a Step Functions state machine.
- Timestream
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Timestream Action - Writes attributes from an MQTT message.
- Cloudwatch
Alarm TopicRule Cloudwatch Alarm Action - Change the state of a CloudWatch alarm.
- Cloudwatch
Logs TopicRule Cloudwatch Logs Action - Sends data to CloudWatch.
- Cloudwatch
Metric TopicRule Cloudwatch Metric Action - Capture a CloudWatch metric.
- Dynamo
DBv2 TopicRule Dynamo DBv2Action - Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
- Dynamo
Db TopicRule Dynamo Db Action - Write to a DynamoDB table.
- Elasticsearch
Topic
Rule Elasticsearch Action Write data to an Amazon OpenSearch Service domain.
The
Elasticsearch
action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use theOpenSearch
rule action instead. For more information, see OpenSearchAction .- Firehose
Topic
Rule Firehose Action - Write to an Amazon Kinesis Firehose stream.
- Http
Topic
Rule Http Action - Send data to an HTTPS endpoint.
- Iot
Analytics TopicRule Iot Analytics Action - Sends message data to an AWS IoT Analytics channel.
- Iot
Events TopicRule Iot Events Action - Sends an input to an AWS IoT Events detector.
- Iot
Site TopicWise Rule Iot Site Wise Action - Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
- Kafka
Topic
Rule Kafka Action - Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
- Kinesis
Topic
Rule Kinesis Action - Write data to an Amazon Kinesis stream.
- Lambda
Topic
Rule Lambda Action - Invoke a Lambda function.
- Location
Topic
Rule Location Action - Sends device location data to Amazon Location Service .
- Open
Search TopicRule Open Search Action - Write data to an Amazon OpenSearch Service domain.
- Republish
Topic
Rule Republish Action - Publish to another MQTT topic.
- S3
Topic
Rule S3Action - Write to an Amazon S3 bucket.
- Sns
Topic
Rule Sns Action - Publish to an Amazon SNS topic.
- Sqs
Topic
Rule Sqs Action - Publish to an Amazon SQS queue.
- Step
Functions TopicRule Step Functions Action - Starts execution of a Step Functions state machine.
- Timestream
Topic
Rule Timestream Action - Writes attributes from an MQTT message.
- cloudwatch
Alarm TopicRule Cloudwatch Alarm Action - Change the state of a CloudWatch alarm.
- cloudwatch
Logs TopicRule Cloudwatch Logs Action - Sends data to CloudWatch.
- cloudwatch
Metric TopicRule Cloudwatch Metric Action - Capture a CloudWatch metric.
- dynamo
DBv2 TopicRule Dynamo DBv2Action - Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
- dynamo
Db TopicRule Dynamo Db Action - Write to a DynamoDB table.
- elasticsearch
Topic
Rule Elasticsearch Action Write data to an Amazon OpenSearch Service domain.
The
Elasticsearch
action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use theOpenSearch
rule action instead. For more information, see OpenSearchAction .- firehose
Topic
Rule Firehose Action - Write to an Amazon Kinesis Firehose stream.
- http
Topic
Rule Http Action - Send data to an HTTPS endpoint.
- iot
Analytics TopicRule Iot Analytics Action - Sends message data to an AWS IoT Analytics channel.
- iot
Events TopicRule Iot Events Action - Sends an input to an AWS IoT Events detector.
- iot
Site TopicWise Rule Iot Site Wise Action - Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
- kafka
Topic
Rule Kafka Action - Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
- kinesis
Topic
Rule Kinesis Action - Write data to an Amazon Kinesis stream.
- lambda
Topic
Rule Lambda Action - Invoke a Lambda function.
- location
Topic
Rule Location Action - Sends device location data to Amazon Location Service .
- open
Search TopicRule Open Search Action - Write data to an Amazon OpenSearch Service domain.
- republish
Topic
Rule Republish Action - Publish to another MQTT topic.
- s3
Topic
Rule S3Action - Write to an Amazon S3 bucket.
- sns
Topic
Rule Sns Action - Publish to an Amazon SNS topic.
- sqs
Topic
Rule Sqs Action - Publish to an Amazon SQS queue.
- step
Functions TopicRule Step Functions Action - Starts execution of a Step Functions state machine.
- timestream
Topic
Rule Timestream Action - Writes attributes from an MQTT message.
- cloudwatch
Alarm TopicRule Cloudwatch Alarm Action - Change the state of a CloudWatch alarm.
- cloudwatch
Logs TopicRule Cloudwatch Logs Action - Sends data to CloudWatch.
- cloudwatch
Metric TopicRule Cloudwatch Metric Action - Capture a CloudWatch metric.
- dynamo
DBv2 TopicRule Dynamo DBv2Action - Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
- dynamo
Db TopicRule Dynamo Db Action - Write to a DynamoDB table.
- elasticsearch
Topic
Rule Elasticsearch Action Write data to an Amazon OpenSearch Service domain.
The
Elasticsearch
action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use theOpenSearch
rule action instead. For more information, see OpenSearchAction .- firehose
Topic
Rule Firehose Action - Write to an Amazon Kinesis Firehose stream.
- http
Topic
Rule Http Action - Send data to an HTTPS endpoint.
- iot
Analytics TopicRule Iot Analytics Action - Sends message data to an AWS IoT Analytics channel.
- iot
Events TopicRule Iot Events Action - Sends an input to an AWS IoT Events detector.
- iot
Site TopicWise Rule Iot Site Wise Action - Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
- kafka
Topic
Rule Kafka Action - Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
- kinesis
Topic
Rule Kinesis Action - Write data to an Amazon Kinesis stream.
- lambda
Topic
Rule Lambda Action - Invoke a Lambda function.
- location
Topic
Rule Location Action - Sends device location data to Amazon Location Service .
- open
Search TopicRule Open Search Action - Write data to an Amazon OpenSearch Service domain.
- republish
Topic
Rule Republish Action - Publish to another MQTT topic.
- s3
Topic
Rule S3Action - Write to an Amazon S3 bucket.
- sns
Topic
Rule Sns Action - Publish to an Amazon SNS topic.
- sqs
Topic
Rule Sqs Action - Publish to an Amazon SQS queue.
- step
Functions TopicRule Step Functions Action - Starts execution of a Step Functions state machine.
- timestream
Topic
Rule Timestream Action - Writes attributes from an MQTT message.
- cloudwatch_
alarm TopicRule Cloudwatch Alarm Action - Change the state of a CloudWatch alarm.
- cloudwatch_
logs TopicRule Cloudwatch Logs Action - Sends data to CloudWatch.
- cloudwatch_
metric TopicRule Cloudwatch Metric Action - Capture a CloudWatch metric.
- dynamo_
d_ Topicbv2 Rule Dynamo DBv2Action - Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
- dynamo_
db TopicRule Dynamo Db Action - Write to a DynamoDB table.
- elasticsearch
Topic
Rule Elasticsearch Action Write data to an Amazon OpenSearch Service domain.
The
Elasticsearch
action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use theOpenSearch
rule action instead. For more information, see OpenSearchAction .- firehose
Topic
Rule Firehose Action - Write to an Amazon Kinesis Firehose stream.
- http
Topic
Rule Http Action - Send data to an HTTPS endpoint.
- iot_
analytics TopicRule Iot Analytics Action - Sends message data to an AWS IoT Analytics channel.
- iot_
events TopicRule Iot Events Action - Sends an input to an AWS IoT Events detector.
- iot_
site_ Topicwise Rule Iot Site Wise Action - Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
- kafka
Topic
Rule Kafka Action - Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
- kinesis
Topic
Rule Kinesis Action - Write data to an Amazon Kinesis stream.
- lambda_
Topic
Rule Lambda Action - Invoke a Lambda function.
- location
Topic
Rule Location Action - Sends device location data to Amazon Location Service .
- open_
search TopicRule Open Search Action - Write data to an Amazon OpenSearch Service domain.
- republish
Topic
Rule Republish Action - Publish to another MQTT topic.
- s3
Topic
Rule S3Action - Write to an Amazon S3 bucket.
- sns
Topic
Rule Sns Action - Publish to an Amazon SNS topic.
- sqs
Topic
Rule Sqs Action - Publish to an Amazon SQS queue.
- step_
functions TopicRule Step Functions Action - Starts execution of a Step Functions state machine.
- timestream
Topic
Rule Timestream Action - Writes attributes from an MQTT message.
- cloudwatch
Alarm Property Map - Change the state of a CloudWatch alarm.
- cloudwatch
Logs Property Map - Sends data to CloudWatch.
- cloudwatch
Metric Property Map - Capture a CloudWatch metric.
- dynamo
DBv2 Property Map - Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
- dynamo
Db Property Map - Write to a DynamoDB table.
- elasticsearch Property Map
Write data to an Amazon OpenSearch Service domain.
The
Elasticsearch
action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use theOpenSearch
rule action instead. For more information, see OpenSearchAction .- firehose Property Map
- Write to an Amazon Kinesis Firehose stream.
- http Property Map
- Send data to an HTTPS endpoint.
- iot
Analytics Property Map - Sends message data to an AWS IoT Analytics channel.
- iot
Events Property Map - Sends an input to an AWS IoT Events detector.
- iot
Site Property MapWise - Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
- kafka Property Map
- Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
- kinesis Property Map
- Write data to an Amazon Kinesis stream.
- lambda Property Map
- Invoke a Lambda function.
- location Property Map
- Sends device location data to Amazon Location Service .
- open
Search Property Map - Write data to an Amazon OpenSearch Service domain.
- republish Property Map
- Publish to another MQTT topic.
- s3 Property Map
- Write to an Amazon S3 bucket.
- sns Property Map
- Publish to an Amazon SNS topic.
- sqs Property Map
- Publish to an Amazon SQS queue.
- step
Functions Property Map - Starts execution of a Step Functions state machine.
- timestream Property Map
- Writes attributes from an MQTT message.
TopicRuleAssetPropertyTimestamp
- Time
In stringSeconds - A string that contains the time in seconds since epoch. Accepts substitution templates.
- Offset
In stringNanos - Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
- Time
In stringSeconds - A string that contains the time in seconds since epoch. Accepts substitution templates.
- Offset
In stringNanos - Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
- time
In StringSeconds - A string that contains the time in seconds since epoch. Accepts substitution templates.
- offset
In StringNanos - Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
- time
In stringSeconds - A string that contains the time in seconds since epoch. Accepts substitution templates.
- offset
In stringNanos - Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
- time_
in_ strseconds - A string that contains the time in seconds since epoch. Accepts substitution templates.
- offset_
in_ strnanos - Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
- time
In StringSeconds - A string that contains the time in seconds since epoch. Accepts substitution templates.
- offset
In StringNanos - Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
TopicRuleAssetPropertyValue
- Timestamp
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Asset Property Timestamp - The asset property value timestamp.
- Value
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Asset Property Variant - The value of the asset property.
- Quality string
- Optional. A string that describes the quality of the value. Accepts substitution templates. Must be
GOOD
,BAD
, orUNCERTAIN
.
- Timestamp
Topic
Rule Asset Property Timestamp - The asset property value timestamp.
- Value
Topic
Rule Asset Property Variant - The value of the asset property.
- Quality string
- Optional. A string that describes the quality of the value. Accepts substitution templates. Must be
GOOD
,BAD
, orUNCERTAIN
.
- timestamp
Topic
Rule Asset Property Timestamp - The asset property value timestamp.
- value
Topic
Rule Asset Property Variant - The value of the asset property.
- quality String
- Optional. A string that describes the quality of the value. Accepts substitution templates. Must be
GOOD
,BAD
, orUNCERTAIN
.
- timestamp
Topic
Rule Asset Property Timestamp - The asset property value timestamp.
- value
Topic
Rule Asset Property Variant - The value of the asset property.
- quality string
- Optional. A string that describes the quality of the value. Accepts substitution templates. Must be
GOOD
,BAD
, orUNCERTAIN
.
- timestamp
Topic
Rule Asset Property Timestamp - The asset property value timestamp.
- value
Topic
Rule Asset Property Variant - The value of the asset property.
- quality str
- Optional. A string that describes the quality of the value. Accepts substitution templates. Must be
GOOD
,BAD
, orUNCERTAIN
.
- timestamp Property Map
- The asset property value timestamp.
- value Property Map
- The value of the asset property.
- quality String
- Optional. A string that describes the quality of the value. Accepts substitution templates. Must be
GOOD
,BAD
, orUNCERTAIN
.
TopicRuleAssetPropertyVariant
- Boolean
Value string - Optional. A string that contains the boolean value (
true
orfalse
) of the value entry. Accepts substitution templates. - Double
Value string - Optional. A string that contains the double value of the value entry. Accepts substitution templates.
- Integer
Value string - Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
- String
Value string - Optional. The string value of the value entry. Accepts substitution templates.
- Boolean
Value string - Optional. A string that contains the boolean value (
true
orfalse
) of the value entry. Accepts substitution templates. - Double
Value string - Optional. A string that contains the double value of the value entry. Accepts substitution templates.
- Integer
Value string - Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
- String
Value string - Optional. The string value of the value entry. Accepts substitution templates.
- boolean
Value String - Optional. A string that contains the boolean value (
true
orfalse
) of the value entry. Accepts substitution templates. - double
Value String - Optional. A string that contains the double value of the value entry. Accepts substitution templates.
- integer
Value String - Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
- string
Value String - Optional. The string value of the value entry. Accepts substitution templates.
- boolean
Value string - Optional. A string that contains the boolean value (
true
orfalse
) of the value entry. Accepts substitution templates. - double
Value string - Optional. A string that contains the double value of the value entry. Accepts substitution templates.
- integer
Value string - Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
- string
Value string - Optional. The string value of the value entry. Accepts substitution templates.
- boolean_
value str - Optional. A string that contains the boolean value (
true
orfalse
) of the value entry. Accepts substitution templates. - double_
value str - Optional. A string that contains the double value of the value entry. Accepts substitution templates.
- integer_
value str - Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
- string_
value str - Optional. The string value of the value entry. Accepts substitution templates.
- boolean
Value String - Optional. A string that contains the boolean value (
true
orfalse
) of the value entry. Accepts substitution templates. - double
Value String - Optional. A string that contains the double value of the value entry. Accepts substitution templates.
- integer
Value String - Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
- string
Value String - Optional. The string value of the value entry. Accepts substitution templates.
TopicRuleCannedAccessControlList
TopicRuleCloudwatchAlarmAction
- Alarm
Name string - The CloudWatch alarm name.
- Role
Arn string - The IAM role that allows access to the CloudWatch alarm.
- State
Reason string - The reason for the alarm change.
- State
Value string - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- Alarm
Name string - The CloudWatch alarm name.
- Role
Arn string - The IAM role that allows access to the CloudWatch alarm.
- State
Reason string - The reason for the alarm change.
- State
Value string - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm
Name String - The CloudWatch alarm name.
- role
Arn String - The IAM role that allows access to the CloudWatch alarm.
- state
Reason String - The reason for the alarm change.
- state
Value String - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm
Name string - The CloudWatch alarm name.
- role
Arn string - The IAM role that allows access to the CloudWatch alarm.
- state
Reason string - The reason for the alarm change.
- state
Value string - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm_
name str - The CloudWatch alarm name.
- role_
arn str - The IAM role that allows access to the CloudWatch alarm.
- state_
reason str - The reason for the alarm change.
- state_
value str - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm
Name String - The CloudWatch alarm name.
- role
Arn String - The IAM role that allows access to the CloudWatch alarm.
- state
Reason String - The reason for the alarm change.
- state
Value String - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
TopicRuleCloudwatchLogsAction
- Log
Group stringName - The CloudWatch log name.
- Role
Arn string - The IAM role that allows access to the CloudWatch log.
- Batch
Mode bool - Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
- Log
Group stringName - The CloudWatch log name.
- Role
Arn string - The IAM role that allows access to the CloudWatch log.
- Batch
Mode bool - Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
- log
Group StringName - The CloudWatch log name.
- role
Arn String - The IAM role that allows access to the CloudWatch log.
- batch
Mode Boolean - Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
- log
Group stringName - The CloudWatch log name.
- role
Arn string - The IAM role that allows access to the CloudWatch log.
- batch
Mode boolean - Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
- log_
group_ strname - The CloudWatch log name.
- role_
arn str - The IAM role that allows access to the CloudWatch log.
- batch_
mode bool - Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
- log
Group StringName - The CloudWatch log name.
- role
Arn String - The IAM role that allows access to the CloudWatch log.
- batch
Mode Boolean - Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
TopicRuleCloudwatchMetricAction
- Metric
Name string - The CloudWatch metric name.
- Metric
Namespace string - The CloudWatch metric namespace name.
- Metric
Unit string - The metric unit supported by CloudWatch.
- Metric
Value string - The CloudWatch metric value.
- Role
Arn string - The IAM role that allows access to the CloudWatch metric.
- Metric
Timestamp string - An optional Unix timestamp .
- Metric
Name string - The CloudWatch metric name.
- Metric
Namespace string - The CloudWatch metric namespace name.
- Metric
Unit string - The metric unit supported by CloudWatch.
- Metric
Value string - The CloudWatch metric value.
- Role
Arn string - The IAM role that allows access to the CloudWatch metric.
- Metric
Timestamp string - An optional Unix timestamp .
- metric
Name String - The CloudWatch metric name.
- metric
Namespace String - The CloudWatch metric namespace name.
- metric
Unit String - The metric unit supported by CloudWatch.
- metric
Value String - The CloudWatch metric value.
- role
Arn String - The IAM role that allows access to the CloudWatch metric.
- metric
Timestamp String - An optional Unix timestamp .
- metric
Name string - The CloudWatch metric name.
- metric
Namespace string - The CloudWatch metric namespace name.
- metric
Unit string - The metric unit supported by CloudWatch.
- metric
Value string - The CloudWatch metric value.
- role
Arn string - The IAM role that allows access to the CloudWatch metric.
- metric
Timestamp string - An optional Unix timestamp .
- metric_
name str - The CloudWatch metric name.
- metric_
namespace str - The CloudWatch metric namespace name.
- metric_
unit str - The metric unit supported by CloudWatch.
- metric_
value str - The CloudWatch metric value.
- role_
arn str - The IAM role that allows access to the CloudWatch metric.
- metric_
timestamp str - An optional Unix timestamp .
- metric
Name String - The CloudWatch metric name.
- metric
Namespace String - The CloudWatch metric namespace name.
- metric
Unit String - The metric unit supported by CloudWatch.
- metric
Value String - The CloudWatch metric value.
- role
Arn String - The IAM role that allows access to the CloudWatch metric.
- metric
Timestamp String - An optional Unix timestamp .
TopicRuleDynamoDBv2Action
- Put
Item Pulumi.Aws Native. Io T. Inputs. Topic Rule Put Item Input Specifies the DynamoDB table to which the message data will be written. For example:
{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Put
Item TopicRule Put Item Input Specifies the DynamoDB table to which the message data will be written. For example:
{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- put
Item TopicRule Put Item Input Specifies the DynamoDB table to which the message data will be written. For example:
{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- put
Item TopicRule Put Item Input Specifies the DynamoDB table to which the message data will be written. For example:
{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
- role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- put_
item TopicRule Put Item Input Specifies the DynamoDB table to which the message data will be written. For example:
{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
- role_
arn str - The ARN of the IAM role that grants access to the DynamoDB table.
- put
Item Property Map Specifies the DynamoDB table to which the message data will be written. For example:
{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
TopicRuleDynamoDbAction
- Hash
Key stringField - The hash key name.
- Hash
Key stringValue - The hash key value.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Table
Name string - The name of the DynamoDB table.
- Hash
Key stringType - The hash key type. Valid values are "STRING" or "NUMBER"
- Payload
Field string - The action payload. This name can be customized.
- Range
Key stringField - The range key name.
- Range
Key stringType - The range key type. Valid values are "STRING" or "NUMBER"
- Range
Key stringValue - The range key value.
- Hash
Key stringField - The hash key name.
- Hash
Key stringValue - The hash key value.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Table
Name string - The name of the DynamoDB table.
- Hash
Key stringType - The hash key type. Valid values are "STRING" or "NUMBER"
- Payload
Field string - The action payload. This name can be customized.
- Range
Key stringField - The range key name.
- Range
Key stringType - The range key type. Valid values are "STRING" or "NUMBER"
- Range
Key stringValue - The range key value.
- hash
Key StringField - The hash key name.
- hash
Key StringValue - The hash key value.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
- hash
Key StringType - The hash key type. Valid values are "STRING" or "NUMBER"
- payload
Field String - The action payload. This name can be customized.
- range
Key StringField - The range key name.
- range
Key StringType - The range key type. Valid values are "STRING" or "NUMBER"
- range
Key StringValue - The range key value.
- hash
Key stringField - The hash key name.
- hash
Key stringValue - The hash key value.
- role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- table
Name string - The name of the DynamoDB table.
- hash
Key stringType - The hash key type. Valid values are "STRING" or "NUMBER"
- payload
Field string - The action payload. This name can be customized.
- range
Key stringField - The range key name.
- range
Key stringType - The range key type. Valid values are "STRING" or "NUMBER"
- range
Key stringValue - The range key value.
- hash_
key_ strfield - The hash key name.
- hash_
key_ strvalue - The hash key value.
- role_
arn str - The ARN of the IAM role that grants access to the DynamoDB table.
- table_
name str - The name of the DynamoDB table.
- hash_
key_ strtype - The hash key type. Valid values are "STRING" or "NUMBER"
- payload_
field str - The action payload. This name can be customized.
- range_
key_ strfield - The range key name.
- range_
key_ strtype - The range key type. Valid values are "STRING" or "NUMBER"
- range_
key_ strvalue - The range key value.
- hash
Key StringField - The hash key name.
- hash
Key StringValue - The hash key value.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
- hash
Key StringType - The hash key type. Valid values are "STRING" or "NUMBER"
- payload
Field String - The action payload. This name can be customized.
- range
Key StringField - The range key name.
- range
Key StringType - The range key type. Valid values are "STRING" or "NUMBER"
- range
Key StringValue - The range key value.
TopicRuleElasticsearchAction
TopicRuleFirehoseAction
- Delivery
Stream stringName - The delivery stream name.
- Role
Arn string - The IAM role that grants access to the Amazon Kinesis Firehose stream.
- Batch
Mode bool Whether to deliver the Kinesis Data Firehose stream as a batch by using
PutRecordBatch
. The default value isfalse
.When
batchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
request. The resulting array can't have more than 500 records.- Separator string
- A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- Delivery
Stream stringName - The delivery stream name.
- Role
Arn string - The IAM role that grants access to the Amazon Kinesis Firehose stream.
- Batch
Mode bool Whether to deliver the Kinesis Data Firehose stream as a batch by using
PutRecordBatch
. The default value isfalse
.When
batchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
request. The resulting array can't have more than 500 records.- Separator string
- A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery
Stream StringName - The delivery stream name.
- role
Arn String - The IAM role that grants access to the Amazon Kinesis Firehose stream.
- batch
Mode Boolean Whether to deliver the Kinesis Data Firehose stream as a batch by using
PutRecordBatch
. The default value isfalse
.When
batchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
request. The resulting array can't have more than 500 records.- separator String
- A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery
Stream stringName - The delivery stream name.
- role
Arn string - The IAM role that grants access to the Amazon Kinesis Firehose stream.
- batch
Mode boolean Whether to deliver the Kinesis Data Firehose stream as a batch by using
PutRecordBatch
. The default value isfalse
.When
batchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
request. The resulting array can't have more than 500 records.- separator string
- A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery_
stream_ strname - The delivery stream name.
- role_
arn str - The IAM role that grants access to the Amazon Kinesis Firehose stream.
- batch_
mode bool Whether to deliver the Kinesis Data Firehose stream as a batch by using
PutRecordBatch
. The default value isfalse
.When
batchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
request. The resulting array can't have more than 500 records.- separator str
- A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery
Stream StringName - The delivery stream name.
- role
Arn String - The IAM role that grants access to the Amazon Kinesis Firehose stream.
- batch
Mode Boolean Whether to deliver the Kinesis Data Firehose stream as a batch by using
PutRecordBatch
. The default value isfalse
.When
batchMode
istrue
and the rule's SQL statement evaluates to an Array, each Array element forms one record in thePutRecordBatch
request. The resulting array can't have more than 500 records.- separator String
- A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
TopicRuleHttpAction
- Url string
- The endpoint URL. If substitution templates are used in the URL, you must also specify a
confirmationUrl
. If this is a new destination, a newTopicRuleDestination
is created if possible. - Auth
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Http Authorization - The authentication method to use when sending data to an HTTPS endpoint.
- Confirmation
Url string - The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
- Headers
List<Pulumi.
Aws Native. Io T. Inputs. Topic Rule Http Action Header> - The HTTP headers to send with the message data.
- Url string
- The endpoint URL. If substitution templates are used in the URL, you must also specify a
confirmationUrl
. If this is a new destination, a newTopicRuleDestination
is created if possible. - Auth
Topic
Rule Http Authorization - The authentication method to use when sending data to an HTTPS endpoint.
- Confirmation
Url string - The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
- Headers
[]Topic
Rule Http Action Header - The HTTP headers to send with the message data.
- url String
- The endpoint URL. If substitution templates are used in the URL, you must also specify a
confirmationUrl
. If this is a new destination, a newTopicRuleDestination
is created if possible. - auth
Topic
Rule Http Authorization - The authentication method to use when sending data to an HTTPS endpoint.
- confirmation
Url String - The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
- headers
List<Topic
Rule Http Action Header> - The HTTP headers to send with the message data.
- url string
- The endpoint URL. If substitution templates are used in the URL, you must also specify a
confirmationUrl
. If this is a new destination, a newTopicRuleDestination
is created if possible. - auth
Topic
Rule Http Authorization - The authentication method to use when sending data to an HTTPS endpoint.
- confirmation
Url string - The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
- headers
Topic
Rule Http Action Header[] - The HTTP headers to send with the message data.
- url str
- The endpoint URL. If substitution templates are used in the URL, you must also specify a
confirmationUrl
. If this is a new destination, a newTopicRuleDestination
is created if possible. - auth
Topic
Rule Http Authorization - The authentication method to use when sending data to an HTTPS endpoint.
- confirmation_
url str - The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
- headers
Sequence[Topic
Rule Http Action Header] - The HTTP headers to send with the message data.
- url String
- The endpoint URL. If substitution templates are used in the URL, you must also specify a
confirmationUrl
. If this is a new destination, a newTopicRuleDestination
is created if possible. - auth Property Map
- The authentication method to use when sending data to an HTTPS endpoint.
- confirmation
Url String - The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
- headers List<Property Map>
- The HTTP headers to send with the message data.
TopicRuleHttpActionHeader
TopicRuleHttpAuthorization
- Sigv4
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Sig V4Authorization - Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .
- Sigv4
Topic
Rule Sig V4Authorization - Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .
- sigv4
Topic
Rule Sig V4Authorization - Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .
- sigv4
Topic
Rule Sig V4Authorization - Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .
- sigv4
Topic
Rule Sig V4Authorization - Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .
- sigv4 Property Map
- Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .
TopicRuleIotAnalyticsAction
- Channel
Name string - The name of the IoT Analytics channel to which message data will be sent.
- Role
Arn string - The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
- Batch
Mode bool Whether to process the action as a batch. The default value is
false
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed byBatchPutMessage
The resulting array can't have more than 100 messages.
- Channel
Name string - The name of the IoT Analytics channel to which message data will be sent.
- Role
Arn string - The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
- Batch
Mode bool Whether to process the action as a batch. The default value is
false
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed byBatchPutMessage
The resulting array can't have more than 100 messages.
- channel
Name String - The name of the IoT Analytics channel to which message data will be sent.
- role
Arn String - The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
- batch
Mode Boolean Whether to process the action as a batch. The default value is
false
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed byBatchPutMessage
The resulting array can't have more than 100 messages.
- channel
Name string - The name of the IoT Analytics channel to which message data will be sent.
- role
Arn string - The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
- batch
Mode boolean Whether to process the action as a batch. The default value is
false
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed byBatchPutMessage
The resulting array can't have more than 100 messages.
- channel_
name str - The name of the IoT Analytics channel to which message data will be sent.
- role_
arn str - The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
- batch_
mode bool Whether to process the action as a batch. The default value is
false
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed byBatchPutMessage
The resulting array can't have more than 100 messages.
- channel
Name String - The name of the IoT Analytics channel to which message data will be sent.
- role
Arn String - The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
- batch
Mode Boolean Whether to process the action as a batch. The default value is
false
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed byBatchPutMessage
The resulting array can't have more than 100 messages.
TopicRuleIotEventsAction
- Input
Name string - The name of the AWS IoT Events input.
- Role
Arn string - The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
- Batch
Mode bool Whether to process the event actions as a batch. The default value is
false
.When
batchMode
istrue
, you can't specify amessageId
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by callingBatchPutMessage
. The resulting array can't have more than 10 messages.- Message
Id string The ID of the message. The default
messageId
is a new UUID value.When
batchMode
istrue
, you can't specify amessageId
--a new UUID value will be assigned.Assign a value to this property to ensure that only one input (message) with a given
messageId
will be processed by an AWS IoT Events detector.
- Input
Name string - The name of the AWS IoT Events input.
- Role
Arn string - The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
- Batch
Mode bool Whether to process the event actions as a batch. The default value is
false
.When
batchMode
istrue
, you can't specify amessageId
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by callingBatchPutMessage
. The resulting array can't have more than 10 messages.- Message
Id string The ID of the message. The default
messageId
is a new UUID value.When
batchMode
istrue
, you can't specify amessageId
--a new UUID value will be assigned.Assign a value to this property to ensure that only one input (message) with a given
messageId
will be processed by an AWS IoT Events detector.
- input
Name String - The name of the AWS IoT Events input.
- role
Arn String - The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
- batch
Mode Boolean Whether to process the event actions as a batch. The default value is
false
.When
batchMode
istrue
, you can't specify amessageId
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by callingBatchPutMessage
. The resulting array can't have more than 10 messages.- message
Id String The ID of the message. The default
messageId
is a new UUID value.When
batchMode
istrue
, you can't specify amessageId
--a new UUID value will be assigned.Assign a value to this property to ensure that only one input (message) with a given
messageId
will be processed by an AWS IoT Events detector.
- input
Name string - The name of the AWS IoT Events input.
- role
Arn string - The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
- batch
Mode boolean Whether to process the event actions as a batch. The default value is
false
.When
batchMode
istrue
, you can't specify amessageId
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by callingBatchPutMessage
. The resulting array can't have more than 10 messages.- message
Id string The ID of the message. The default
messageId
is a new UUID value.When
batchMode
istrue
, you can't specify amessageId
--a new UUID value will be assigned.Assign a value to this property to ensure that only one input (message) with a given
messageId
will be processed by an AWS IoT Events detector.
- input_
name str - The name of the AWS IoT Events input.
- role_
arn str - The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
- batch_
mode bool Whether to process the event actions as a batch. The default value is
false
.When
batchMode
istrue
, you can't specify amessageId
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by callingBatchPutMessage
. The resulting array can't have more than 10 messages.- message_
id str The ID of the message. The default
messageId
is a new UUID value.When
batchMode
istrue
, you can't specify amessageId
--a new UUID value will be assigned.Assign a value to this property to ensure that only one input (message) with a given
messageId
will be processed by an AWS IoT Events detector.
- input
Name String - The name of the AWS IoT Events input.
- role
Arn String - The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
- batch
Mode Boolean Whether to process the event actions as a batch. The default value is
false
.When
batchMode
istrue
, you can't specify amessageId
.When
batchMode
istrue
and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by callingBatchPutMessage
. The resulting array can't have more than 10 messages.- message
Id String The ID of the message. The default
messageId
is a new UUID value.When
batchMode
istrue
, you can't specify amessageId
--a new UUID value will be assigned.Assign a value to this property to ensure that only one input (message) with a given
messageId
will be processed by an AWS IoT Events detector.
TopicRuleIotSiteWiseAction
- Put
Asset List<Pulumi.Property Value Entries Aws Native. Io T. Inputs. Topic Rule Put Asset Property Value Entry> - A list of asset property value entries.
- Role
Arn string - The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. (
"Action": "iotsitewise:BatchPutAssetPropertyValue"
). The trust policy can restrict access to specific asset hierarchy paths.
- Put
Asset []TopicProperty Value Entries Rule Put Asset Property Value Entry - A list of asset property value entries.
- Role
Arn string - The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. (
"Action": "iotsitewise:BatchPutAssetPropertyValue"
). The trust policy can restrict access to specific asset hierarchy paths.
- put
Asset List<TopicProperty Value Entries Rule Put Asset Property Value Entry> - A list of asset property value entries.
- role
Arn String - The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. (
"Action": "iotsitewise:BatchPutAssetPropertyValue"
). The trust policy can restrict access to specific asset hierarchy paths.
- put
Asset TopicProperty Value Entries Rule Put Asset Property Value Entry[] - A list of asset property value entries.
- role
Arn string - The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. (
"Action": "iotsitewise:BatchPutAssetPropertyValue"
). The trust policy can restrict access to specific asset hierarchy paths.
- put_
asset_ Sequence[Topicproperty_ value_ entries Rule Put Asset Property Value Entry] - A list of asset property value entries.
- role_
arn str - The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. (
"Action": "iotsitewise:BatchPutAssetPropertyValue"
). The trust policy can restrict access to specific asset hierarchy paths.
- put
Asset List<Property Map>Property Value Entries - A list of asset property value entries.
- role
Arn String - The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. (
"Action": "iotsitewise:BatchPutAssetPropertyValue"
). The trust policy can restrict access to specific asset hierarchy paths.
TopicRuleKafkaAction
- Client
Properties Dictionary<string, string> - Properties of the Apache Kafka producer client.
- Destination
Arn string - The ARN of Kafka action's VPC
TopicRuleDestination
. - Topic string
- The Kafka topic for messages to be sent to the Kafka broker.
- Headers
List<Pulumi.
Aws Native. Io T. Inputs. Topic Rule Kafka Action Header> - The list of Kafka headers that you specify.
- Key string
- The Kafka message key.
- Partition string
- The Kafka message partition.
- Client
Properties map[string]string - Properties of the Apache Kafka producer client.
- Destination
Arn string - The ARN of Kafka action's VPC
TopicRuleDestination
. - Topic string
- The Kafka topic for messages to be sent to the Kafka broker.
- Headers
[]Topic
Rule Kafka Action Header - The list of Kafka headers that you specify.
- Key string
- The Kafka message key.
- Partition string
- The Kafka message partition.
- client
Properties Map<String,String> - Properties of the Apache Kafka producer client.
- destination
Arn String - The ARN of Kafka action's VPC
TopicRuleDestination
. - topic String
- The Kafka topic for messages to be sent to the Kafka broker.
- headers
List<Topic
Rule Kafka Action Header> - The list of Kafka headers that you specify.
- key String
- The Kafka message key.
- partition String
- The Kafka message partition.
- client
Properties {[key: string]: string} - Properties of the Apache Kafka producer client.
- destination
Arn string - The ARN of Kafka action's VPC
TopicRuleDestination
. - topic string
- The Kafka topic for messages to be sent to the Kafka broker.
- headers
Topic
Rule Kafka Action Header[] - The list of Kafka headers that you specify.
- key string
- The Kafka message key.
- partition string
- The Kafka message partition.
- client_
properties Mapping[str, str] - Properties of the Apache Kafka producer client.
- destination_
arn str - The ARN of Kafka action's VPC
TopicRuleDestination
. - topic str
- The Kafka topic for messages to be sent to the Kafka broker.
- headers
Sequence[Topic
Rule Kafka Action Header] - The list of Kafka headers that you specify.
- key str
- The Kafka message key.
- partition str
- The Kafka message partition.
- client
Properties Map<String> - Properties of the Apache Kafka producer client.
- destination
Arn String - The ARN of Kafka action's VPC
TopicRuleDestination
. - topic String
- The Kafka topic for messages to be sent to the Kafka broker.
- headers List<Property Map>
- The list of Kafka headers that you specify.
- key String
- The Kafka message key.
- partition String
- The Kafka message partition.
TopicRuleKafkaActionHeader
TopicRuleKinesisAction
- Role
Arn string - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- Stream
Name string - The name of the Amazon Kinesis stream.
- Partition
Key string - The partition key.
- Role
Arn string - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- Stream
Name string - The name of the Amazon Kinesis stream.
- Partition
Key string - The partition key.
- role
Arn String - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream
Name String - The name of the Amazon Kinesis stream.
- partition
Key String - The partition key.
- role
Arn string - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream
Name string - The name of the Amazon Kinesis stream.
- partition
Key string - The partition key.
- role_
arn str - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream_
name str - The name of the Amazon Kinesis stream.
- partition_
key str - The partition key.
- role
Arn String - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream
Name String - The name of the Amazon Kinesis stream.
- partition
Key String - The partition key.
TopicRuleLambdaAction
- Function
Arn string - The ARN of the Lambda function.
- Function
Arn string - The ARN of the Lambda function.
- function
Arn String - The ARN of the Lambda function.
- function
Arn string - The ARN of the Lambda function.
- function_
arn str - The ARN of the Lambda function.
- function
Arn String - The ARN of the Lambda function.
TopicRuleLocationAction
- Device
Id string - The unique ID of the device providing the location data.
- Latitude string
- A string that evaluates to a double value that represents the latitude of the device's location.
- Longitude string
- A string that evaluates to a double value that represents the longitude of the device's location.
- Role
Arn string - The IAM role that grants permission to write to the Amazon Location resource.
- Tracker
Name string - The name of the tracker resource in Amazon Location in which the location is updated.
- Timestamp
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Timestamp - The time that the location data was sampled. The default value is the time the MQTT message was processed.
- Device
Id string - The unique ID of the device providing the location data.
- Latitude string
- A string that evaluates to a double value that represents the latitude of the device's location.
- Longitude string
- A string that evaluates to a double value that represents the longitude of the device's location.
- Role
Arn string - The IAM role that grants permission to write to the Amazon Location resource.
- Tracker
Name string - The name of the tracker resource in Amazon Location in which the location is updated.
- Timestamp
Topic
Rule Timestamp - The time that the location data was sampled. The default value is the time the MQTT message was processed.
- device
Id String - The unique ID of the device providing the location data.
- latitude String
- A string that evaluates to a double value that represents the latitude of the device's location.
- longitude String
- A string that evaluates to a double value that represents the longitude of the device's location.
- role
Arn String - The IAM role that grants permission to write to the Amazon Location resource.
- tracker
Name String - The name of the tracker resource in Amazon Location in which the location is updated.
- timestamp
Topic
Rule Timestamp - The time that the location data was sampled. The default value is the time the MQTT message was processed.
- device
Id string - The unique ID of the device providing the location data.
- latitude string
- A string that evaluates to a double value that represents the latitude of the device's location.
- longitude string
- A string that evaluates to a double value that represents the longitude of the device's location.
- role
Arn string - The IAM role that grants permission to write to the Amazon Location resource.
- tracker
Name string - The name of the tracker resource in Amazon Location in which the location is updated.
- timestamp
Topic
Rule Timestamp - The time that the location data was sampled. The default value is the time the MQTT message was processed.
- device_
id str - The unique ID of the device providing the location data.
- latitude str
- A string that evaluates to a double value that represents the latitude of the device's location.
- longitude str
- A string that evaluates to a double value that represents the longitude of the device's location.
- role_
arn str - The IAM role that grants permission to write to the Amazon Location resource.
- tracker_
name str - The name of the tracker resource in Amazon Location in which the location is updated.
- timestamp
Topic
Rule Timestamp - The time that the location data was sampled. The default value is the time the MQTT message was processed.
- device
Id String - The unique ID of the device providing the location data.
- latitude String
- A string that evaluates to a double value that represents the latitude of the device's location.
- longitude String
- A string that evaluates to a double value that represents the longitude of the device's location.
- role
Arn String - The IAM role that grants permission to write to the Amazon Location resource.
- tracker
Name String - The name of the tracker resource in Amazon Location in which the location is updated.
- timestamp Property Map
- The time that the location data was sampled. The default value is the time the MQTT message was processed.
TopicRuleOpenSearchAction
TopicRulePayload
- Actions
List<Pulumi.
Aws Native. Io T. Inputs. Topic Rule Action> - The actions associated with the rule.
- Sql string
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
- Aws
Iot stringSql Version The version of the SQL rules engine to use when evaluating the rule.
The default value is 2015-10-08.
- Description string
- The description of the rule.
- Error
Action Pulumi.Aws Native. Io T. Inputs. Topic Rule Action - The action to take when an error occurs.
- Rule
Disabled bool - Specifies whether the rule is disabled.
- Actions
[]Topic
Rule Action - The actions associated with the rule.
- Sql string
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
- Aws
Iot stringSql Version The version of the SQL rules engine to use when evaluating the rule.
The default value is 2015-10-08.
- Description string
- The description of the rule.
- Error
Action TopicRule Action - The action to take when an error occurs.
- Rule
Disabled bool - Specifies whether the rule is disabled.
- actions
List<Topic
Rule Action> - The actions associated with the rule.
- sql String
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
- aws
Iot StringSql Version The version of the SQL rules engine to use when evaluating the rule.
The default value is 2015-10-08.
- description String
- The description of the rule.
- error
Action TopicRule Action - The action to take when an error occurs.
- rule
Disabled Boolean - Specifies whether the rule is disabled.
- actions
Topic
Rule Action[] - The actions associated with the rule.
- sql string
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
- aws
Iot stringSql Version The version of the SQL rules engine to use when evaluating the rule.
The default value is 2015-10-08.
- description string
- The description of the rule.
- error
Action TopicRule Action - The action to take when an error occurs.
- rule
Disabled boolean - Specifies whether the rule is disabled.
- actions
Sequence[Topic
Rule Action] - The actions associated with the rule.
- sql str
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
- aws_
iot_ strsql_ version The version of the SQL rules engine to use when evaluating the rule.
The default value is 2015-10-08.
- description str
- The description of the rule.
- error_
action TopicRule Action - The action to take when an error occurs.
- rule_
disabled bool - Specifies whether the rule is disabled.
- actions List<Property Map>
- The actions associated with the rule.
- sql String
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
- aws
Iot StringSql Version The version of the SQL rules engine to use when evaluating the rule.
The default value is 2015-10-08.
- description String
- The description of the rule.
- error
Action Property Map - The action to take when an error occurs.
- rule
Disabled Boolean - Specifies whether the rule is disabled.
TopicRulePutAssetPropertyValueEntry
- Property
Values List<Pulumi.Aws Native. Io T. Inputs. Topic Rule Asset Property Value> - A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
- Asset
Id string - The ID of the AWS IoT SiteWise asset. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - Entry
Id string - Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
- Property
Alias string - The name of the property alias associated with your asset property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - Property
Id string - The ID of the asset's property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates.
- Property
Values []TopicRule Asset Property Value - A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
- Asset
Id string - The ID of the AWS IoT SiteWise asset. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - Entry
Id string - Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
- Property
Alias string - The name of the property alias associated with your asset property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - Property
Id string - The ID of the asset's property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates.
- property
Values List<TopicRule Asset Property Value> - A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
- asset
Id String - The ID of the AWS IoT SiteWise asset. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - entry
Id String - Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
- property
Alias String - The name of the property alias associated with your asset property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - property
Id String - The ID of the asset's property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates.
- property
Values TopicRule Asset Property Value[] - A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
- asset
Id string - The ID of the AWS IoT SiteWise asset. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - entry
Id string - Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
- property
Alias string - The name of the property alias associated with your asset property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - property
Id string - The ID of the asset's property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates.
- property_
values Sequence[TopicRule Asset Property Value] - A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
- asset_
id str - The ID of the AWS IoT SiteWise asset. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - entry_
id str - Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
- property_
alias str - The name of the property alias associated with your asset property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - property_
id str - The ID of the asset's property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates.
- property
Values List<Property Map> - A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
- asset
Id String - The ID of the AWS IoT SiteWise asset. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - entry
Id String - Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
- property
Alias String - The name of the property alias associated with your asset property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates. - property
Id String - The ID of the asset's property. You must specify either a
propertyAlias
or both analiasId
and apropertyId
. Accepts substitution templates.
TopicRulePutItemInput
- Table
Name string - The table where the message data will be written.
- Table
Name string - The table where the message data will be written.
- table
Name String - The table where the message data will be written.
- table
Name string - The table where the message data will be written.
- table_
name str - The table where the message data will be written.
- table
Name String - The table where the message data will be written.
TopicRuleRepublishAction
- Role
Arn string - The ARN of the IAM role that grants access.
- Topic string
- The name of the MQTT topic.
- Headers
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Republish Action Headers - MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.
- Qos int
- The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
- Role
Arn string - The ARN of the IAM role that grants access.
- Topic string
- The name of the MQTT topic.
- Headers
Topic
Rule Republish Action Headers - MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.
- Qos int
- The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
- role
Arn String - The ARN of the IAM role that grants access.
- topic String
- The name of the MQTT topic.
- headers
Topic
Rule Republish Action Headers - MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.
- qos Integer
- The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
- role
Arn string - The ARN of the IAM role that grants access.
- topic string
- The name of the MQTT topic.
- headers
Topic
Rule Republish Action Headers - MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.
- qos number
- The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
- role_
arn str - The ARN of the IAM role that grants access.
- topic str
- The name of the MQTT topic.
- headers
Topic
Rule Republish Action Headers - MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.
- qos int
- The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
- role
Arn String - The ARN of the IAM role that grants access.
- topic String
- The name of the MQTT topic.
- headers Property Map
- MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.
- qos Number
- The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
TopicRuleRepublishActionHeaders
- Content
Type string A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type in the MQTT Version 5.0 specification.
Supports substitution templates .
- Correlation
Data string The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
For more information, see Correlation Data in the MQTT Version 5.0 specification.
Supports substitution templates .
This binary data must be base64-encoded.
- Message
Expiry string A user-defined integer value that represents the message expiry interval at the broker. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed. The value of
messageExpiry
represents the number of seconds before it expires. For more information about the limits ofmessageExpiry
, see Message broker and protocol limits and quotas in the IoT Core Reference Guide.Supports substitution templates .
- Payload
Format stringIndicator An
Enum
string value that indicates whether the payload is formatted as UTF-8.Valid values are
UNSPECIFIED_BYTES
andUTF8_DATA
.For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates .
- Response
Topic string A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic to which the receiver should publish as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic in the MQTT Version 5.0 specification.
Supports substitution templates .
- User
Properties List<Pulumi.Aws Native. Io T. Inputs. Topic Rule User Property> - An array of key-value pairs that you define in the MQTT5 header.
- Content
Type string A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type in the MQTT Version 5.0 specification.
Supports substitution templates .
- Correlation
Data string The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
For more information, see Correlation Data in the MQTT Version 5.0 specification.
Supports substitution templates .
This binary data must be base64-encoded.
- Message
Expiry string A user-defined integer value that represents the message expiry interval at the broker. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed. The value of
messageExpiry
represents the number of seconds before it expires. For more information about the limits ofmessageExpiry
, see Message broker and protocol limits and quotas in the IoT Core Reference Guide.Supports substitution templates .
- Payload
Format stringIndicator An
Enum
string value that indicates whether the payload is formatted as UTF-8.Valid values are
UNSPECIFIED_BYTES
andUTF8_DATA
.For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates .
- Response
Topic string A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic to which the receiver should publish as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic in the MQTT Version 5.0 specification.
Supports substitution templates .
- User
Properties []TopicRule User Property - An array of key-value pairs that you define in the MQTT5 header.
- content
Type String A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type in the MQTT Version 5.0 specification.
Supports substitution templates .
- correlation
Data String The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
For more information, see Correlation Data in the MQTT Version 5.0 specification.
Supports substitution templates .
This binary data must be base64-encoded.
- message
Expiry String A user-defined integer value that represents the message expiry interval at the broker. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed. The value of
messageExpiry
represents the number of seconds before it expires. For more information about the limits ofmessageExpiry
, see Message broker and protocol limits and quotas in the IoT Core Reference Guide.Supports substitution templates .
- payload
Format StringIndicator An
Enum
string value that indicates whether the payload is formatted as UTF-8.Valid values are
UNSPECIFIED_BYTES
andUTF8_DATA
.For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates .
- response
Topic String A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic to which the receiver should publish as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic in the MQTT Version 5.0 specification.
Supports substitution templates .
- user
Properties List<TopicRule User Property> - An array of key-value pairs that you define in the MQTT5 header.
- content
Type string A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type in the MQTT Version 5.0 specification.
Supports substitution templates .
- correlation
Data string The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
For more information, see Correlation Data in the MQTT Version 5.0 specification.
Supports substitution templates .
This binary data must be base64-encoded.
- message
Expiry string A user-defined integer value that represents the message expiry interval at the broker. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed. The value of
messageExpiry
represents the number of seconds before it expires. For more information about the limits ofmessageExpiry
, see Message broker and protocol limits and quotas in the IoT Core Reference Guide.Supports substitution templates .
- payload
Format stringIndicator An
Enum
string value that indicates whether the payload is formatted as UTF-8.Valid values are
UNSPECIFIED_BYTES
andUTF8_DATA
.For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates .
- response
Topic string A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic to which the receiver should publish as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic in the MQTT Version 5.0 specification.
Supports substitution templates .
- user
Properties TopicRule User Property[] - An array of key-value pairs that you define in the MQTT5 header.
- content_
type str A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type in the MQTT Version 5.0 specification.
Supports substitution templates .
- correlation_
data str The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
For more information, see Correlation Data in the MQTT Version 5.0 specification.
Supports substitution templates .
This binary data must be base64-encoded.
- message_
expiry str A user-defined integer value that represents the message expiry interval at the broker. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed. The value of
messageExpiry
represents the number of seconds before it expires. For more information about the limits ofmessageExpiry
, see Message broker and protocol limits and quotas in the IoT Core Reference Guide.Supports substitution templates .
- payload_
format_ strindicator An
Enum
string value that indicates whether the payload is formatted as UTF-8.Valid values are
UNSPECIFIED_BYTES
andUTF8_DATA
.For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates .
- response_
topic str A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic to which the receiver should publish as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic in the MQTT Version 5.0 specification.
Supports substitution templates .
- user_
properties Sequence[TopicRule User Property] - An array of key-value pairs that you define in the MQTT5 header.
- content
Type String A UTF-8 encoded string that describes the content of the publishing message.
For more information, see Content Type in the MQTT Version 5.0 specification.
Supports substitution templates .
- correlation
Data String The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
For more information, see Correlation Data in the MQTT Version 5.0 specification.
Supports substitution templates .
This binary data must be base64-encoded.
- message
Expiry String A user-defined integer value that represents the message expiry interval at the broker. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed. The value of
messageExpiry
represents the number of seconds before it expires. For more information about the limits ofmessageExpiry
, see Message broker and protocol limits and quotas in the IoT Core Reference Guide.Supports substitution templates .
- payload
Format StringIndicator An
Enum
string value that indicates whether the payload is formatted as UTF-8.Valid values are
UNSPECIFIED_BYTES
andUTF8_DATA
.For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.
Supports substitution templates .
- response
Topic String A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic to which the receiver should publish as part of the request-response flow. The topic must not contain wildcard characters.
For more information, see Response Topic in the MQTT Version 5.0 specification.
Supports substitution templates .
- user
Properties List<Property Map> - An array of key-value pairs that you define in the MQTT5 header.
TopicRuleS3Action
- Bucket
Name string - The Amazon S3 bucket.
- Key string
- The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
- Role
Arn string - The ARN of the IAM role that grants access.
- Canned
Acl Pulumi.Aws Native. Io T. Topic Rule Canned Access Control List - The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
- Bucket
Name string - The Amazon S3 bucket.
- Key string
- The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
- Role
Arn string - The ARN of the IAM role that grants access.
- Canned
Acl TopicRule Canned Access Control List - The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
- bucket
Name String - The Amazon S3 bucket.
- key String
- The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
- role
Arn String - The ARN of the IAM role that grants access.
- canned
Acl TopicRule Canned Access Control List - The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
- bucket
Name string - The Amazon S3 bucket.
- key string
- The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
- role
Arn string - The ARN of the IAM role that grants access.
- canned
Acl TopicRule Canned Access Control List - The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
- bucket_
name str - The Amazon S3 bucket.
- key str
- The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
- role_
arn str - The ARN of the IAM role that grants access.
- canned_
acl TopicRule Canned Access Control List - The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
- bucket
Name String - The Amazon S3 bucket.
- key String
- The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
- role
Arn String - The ARN of the IAM role that grants access.
- canned
Acl "private" | "public-read" | "public-read-write" | "aws-exec-read" | "authenticated-read" | "bucket-owner-read" | "bucket-owner-full-control" | "log-delivery-write" - The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
TopicRuleSigV4Authorization
- Role
Arn string - The ARN of the signing role.
- Service
Name string - The service name to use while signing with Sig V4.
- Signing
Region string - The signing region.
- Role
Arn string - The ARN of the signing role.
- Service
Name string - The service name to use while signing with Sig V4.
- Signing
Region string - The signing region.
- role
Arn String - The ARN of the signing role.
- service
Name String - The service name to use while signing with Sig V4.
- signing
Region String - The signing region.
- role
Arn string - The ARN of the signing role.
- service
Name string - The service name to use while signing with Sig V4.
- signing
Region string - The signing region.
- role_
arn str - The ARN of the signing role.
- service_
name str - The service name to use while signing with Sig V4.
- signing_
region str - The signing region.
- role
Arn String - The ARN of the signing role.
- service
Name String - The service name to use while signing with Sig V4.
- signing
Region String - The signing region.
TopicRuleSnsAction
- Role
Arn string - The ARN of the IAM role that grants access.
- Target
Arn string - The ARN of the SNS topic.
- Message
Format string - (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see Amazon SNS Message and JSON Formats in the Amazon Simple Notification Service Developer Guide .
- Role
Arn string - The ARN of the IAM role that grants access.
- Target
Arn string - The ARN of the SNS topic.
- Message
Format string - (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see Amazon SNS Message and JSON Formats in the Amazon Simple Notification Service Developer Guide .
- role
Arn String - The ARN of the IAM role that grants access.
- target
Arn String - The ARN of the SNS topic.
- message
Format String - (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see Amazon SNS Message and JSON Formats in the Amazon Simple Notification Service Developer Guide .
- role
Arn string - The ARN of the IAM role that grants access.
- target
Arn string - The ARN of the SNS topic.
- message
Format string - (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see Amazon SNS Message and JSON Formats in the Amazon Simple Notification Service Developer Guide .
- role_
arn str - The ARN of the IAM role that grants access.
- target_
arn str - The ARN of the SNS topic.
- message_
format str - (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see Amazon SNS Message and JSON Formats in the Amazon Simple Notification Service Developer Guide .
- role
Arn String - The ARN of the IAM role that grants access.
- target
Arn String - The ARN of the SNS topic.
- message
Format String - (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see Amazon SNS Message and JSON Formats in the Amazon Simple Notification Service Developer Guide .
TopicRuleSqsAction
- queue_
url str - The URL of the Amazon SQS queue.
- role_
arn str - The ARN of the IAM role that grants access.
- use_
base64 bool - Specifies whether to use Base64 encoding.
TopicRuleStepFunctionsAction
- Role
Arn string - The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
- State
Machine stringName - The name of the Step Functions state machine whose execution will be started.
- Execution
Name stringPrefix - (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
- Role
Arn string - The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
- State
Machine stringName - The name of the Step Functions state machine whose execution will be started.
- Execution
Name stringPrefix - (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
- role
Arn String - The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
- state
Machine StringName - The name of the Step Functions state machine whose execution will be started.
- execution
Name StringPrefix - (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
- role
Arn string - The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
- state
Machine stringName - The name of the Step Functions state machine whose execution will be started.
- execution
Name stringPrefix - (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
- role_
arn str - The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
- state_
machine_ strname - The name of the Step Functions state machine whose execution will be started.
- execution_
name_ strprefix - (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
- role
Arn String - The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
- state
Machine StringName - The name of the Step Functions state machine whose execution will be started.
- execution
Name StringPrefix - (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
TopicRuleTimestamp
TopicRuleTimestreamAction
- Database
Name string - The name of an Amazon Timestream database that has the table to write records into.
- Dimensions
List<Pulumi.
Aws Native. Io T. Inputs. Topic Rule Timestream Dimension> - Metadata attributes of the time series that are written in each measure record.
- Role
Arn string - The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
- Table
Name string - The table where the message data will be written.
- Timestamp
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Timestream Timestamp - The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
- Database
Name string - The name of an Amazon Timestream database that has the table to write records into.
- Dimensions
[]Topic
Rule Timestream Dimension - Metadata attributes of the time series that are written in each measure record.
- Role
Arn string - The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
- Table
Name string - The table where the message data will be written.
- Timestamp
Topic
Rule Timestream Timestamp - The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
- database
Name String - The name of an Amazon Timestream database that has the table to write records into.
- dimensions
List<Topic
Rule Timestream Dimension> - Metadata attributes of the time series that are written in each measure record.
- role
Arn String - The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
- table
Name String - The table where the message data will be written.
- timestamp
Topic
Rule Timestream Timestamp - The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
- database
Name string - The name of an Amazon Timestream database that has the table to write records into.
- dimensions
Topic
Rule Timestream Dimension[] - Metadata attributes of the time series that are written in each measure record.
- role
Arn string - The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
- table
Name string - The table where the message data will be written.
- timestamp
Topic
Rule Timestream Timestamp - The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
- database_
name str - The name of an Amazon Timestream database that has the table to write records into.
- dimensions
Sequence[Topic
Rule Timestream Dimension] - Metadata attributes of the time series that are written in each measure record.
- role_
arn str - The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
- table_
name str - The table where the message data will be written.
- timestamp
Topic
Rule Timestream Timestamp - The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
- database
Name String - The name of an Amazon Timestream database that has the table to write records into.
- dimensions List<Property Map>
- Metadata attributes of the time series that are written in each measure record.
- role
Arn String - The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
- table
Name String - The table where the message data will be written.
- timestamp Property Map
- The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
TopicRuleTimestreamDimension
TopicRuleTimestreamTimestamp
TopicRuleUserProperty
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.