1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. TopicRule

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.iot.TopicRule

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource Type definition for AWS::IoT::TopicRule

Create TopicRule Resource

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

Constructor syntax

new TopicRule(name: string, args: TopicRuleArgs, opts?: CustomResourceOptions);
@overload
def TopicRule(resource_name: str,
              args: TopicRuleArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def TopicRule(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              topic_rule_payload: Optional[TopicRulePayloadArgs] = None,
              rule_name: Optional[str] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewTopicRule(ctx *Context, name string, args TopicRuleArgs, opts ...ResourceOption) (*TopicRule, error)
public TopicRule(string name, TopicRuleArgs args, CustomResourceOptions? opts = null)
public TopicRule(String name, TopicRuleArgs args)
public TopicRule(String name, TopicRuleArgs args, CustomResourceOptions options)
type: aws-native:iot:TopicRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TopicRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TopicRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TopicRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TopicRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TopicRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

TopicRule Resource Properties

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

Inputs

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

The TopicRule resource accepts the following input properties:

TopicRulePayload This property is required. Pulumi.AwsNative.IoT.Inputs.TopicRulePayload
The rule payload.
RuleName string
The name of the rule.
Tags List<Pulumi.AwsNative.Inputs.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..."

TopicRulePayload This property is required. TopicRulePayloadArgs
The rule payload.
RuleName string
The name of the rule.
Tags TagArgs

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

topicRulePayload This property is required. TopicRulePayload
The rule payload.
ruleName String
The name of the rule.
tags 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..."

topicRulePayload This property is required. TopicRulePayload
The rule payload.
ruleName string
The name of the rule.
tags 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_payload This property is required. TopicRulePayloadArgs
The rule payload.
rule_name str
The name of the rule.
tags Sequence[TagArgs]

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

topicRulePayload This property is required. Property Map
The rule payload.
ruleName String
The name of the rule.
tags 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..."

Outputs

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

Arn string
The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
Id string
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
id String
The provider-assigned unique ID for this managed resource.
arn string
The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
id string
The provider-assigned unique ID for this managed resource.
arn str
The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
id str
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

TopicRuleAction
, TopicRuleActionArgs

CloudwatchAlarm Pulumi.AwsNative.IoT.Inputs.TopicRuleCloudwatchAlarmAction
Change the state of a CloudWatch alarm.
CloudwatchLogs Pulumi.AwsNative.IoT.Inputs.TopicRuleCloudwatchLogsAction
Sends data to CloudWatch.
CloudwatchMetric Pulumi.AwsNative.IoT.Inputs.TopicRuleCloudwatchMetricAction
Capture a CloudWatch metric.
DynamoDBv2 Pulumi.AwsNative.IoT.Inputs.TopicRuleDynamoDBv2Action
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.
DynamoDb Pulumi.AwsNative.IoT.Inputs.TopicRuleDynamoDbAction
Write to a DynamoDB table.
Elasticsearch Pulumi.AwsNative.IoT.Inputs.TopicRuleElasticsearchAction

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 the OpenSearch rule action instead. For more information, see OpenSearchAction .

Firehose Pulumi.AwsNative.IoT.Inputs.TopicRuleFirehoseAction
Write to an Amazon Kinesis Firehose stream.
Http Pulumi.AwsNative.IoT.Inputs.TopicRuleHttpAction
Send data to an HTTPS endpoint.
IotAnalytics Pulumi.AwsNative.IoT.Inputs.TopicRuleIotAnalyticsAction
Sends message data to an AWS IoT Analytics channel.
IotEvents Pulumi.AwsNative.IoT.Inputs.TopicRuleIotEventsAction
Sends an input to an AWS IoT Events detector.
IotSiteWise Pulumi.AwsNative.IoT.Inputs.TopicRuleIotSiteWiseAction
Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
Kafka Pulumi.AwsNative.IoT.Inputs.TopicRuleKafkaAction
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
Kinesis Pulumi.AwsNative.IoT.Inputs.TopicRuleKinesisAction
Write data to an Amazon Kinesis stream.
Lambda Pulumi.AwsNative.IoT.Inputs.TopicRuleLambdaAction
Invoke a Lambda function.
Location Pulumi.AwsNative.IoT.Inputs.TopicRuleLocationAction
Sends device location data to Amazon Location Service .
OpenSearch Pulumi.AwsNative.IoT.Inputs.TopicRuleOpenSearchAction
Write data to an Amazon OpenSearch Service domain.
Republish Pulumi.AwsNative.IoT.Inputs.TopicRuleRepublishAction
Publish to another MQTT topic.
S3 Pulumi.AwsNative.IoT.Inputs.TopicRuleS3Action
Write to an Amazon S3 bucket.
Sns Pulumi.AwsNative.IoT.Inputs.TopicRuleSnsAction
Publish to an Amazon SNS topic.
Sqs Pulumi.AwsNative.IoT.Inputs.TopicRuleSqsAction
Publish to an Amazon SQS queue.
StepFunctions Pulumi.AwsNative.IoT.Inputs.TopicRuleStepFunctionsAction
Starts execution of a Step Functions state machine.
Timestream Pulumi.AwsNative.IoT.Inputs.TopicRuleTimestreamAction
Writes attributes from an MQTT message.
CloudwatchAlarm TopicRuleCloudwatchAlarmAction
Change the state of a CloudWatch alarm.
CloudwatchLogs TopicRuleCloudwatchLogsAction
Sends data to CloudWatch.
CloudwatchMetric TopicRuleCloudwatchMetricAction
Capture a CloudWatch metric.
DynamoDBv2 TopicRuleDynamoDBv2Action
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.
DynamoDb TopicRuleDynamoDbAction
Write to a DynamoDB table.
Elasticsearch TopicRuleElasticsearchAction

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 the OpenSearch rule action instead. For more information, see OpenSearchAction .

Firehose TopicRuleFirehoseAction
Write to an Amazon Kinesis Firehose stream.
Http TopicRuleHttpAction
Send data to an HTTPS endpoint.
IotAnalytics TopicRuleIotAnalyticsAction
Sends message data to an AWS IoT Analytics channel.
IotEvents TopicRuleIotEventsAction
Sends an input to an AWS IoT Events detector.
IotSiteWise TopicRuleIotSiteWiseAction
Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
Kafka TopicRuleKafkaAction
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
Kinesis TopicRuleKinesisAction
Write data to an Amazon Kinesis stream.
Lambda TopicRuleLambdaAction
Invoke a Lambda function.
Location TopicRuleLocationAction
Sends device location data to Amazon Location Service .
OpenSearch TopicRuleOpenSearchAction
Write data to an Amazon OpenSearch Service domain.
Republish TopicRuleRepublishAction
Publish to another MQTT topic.
S3 TopicRuleS3Action
Write to an Amazon S3 bucket.
Sns TopicRuleSnsAction
Publish to an Amazon SNS topic.
Sqs TopicRuleSqsAction
Publish to an Amazon SQS queue.
StepFunctions TopicRuleStepFunctionsAction
Starts execution of a Step Functions state machine.
Timestream TopicRuleTimestreamAction
Writes attributes from an MQTT message.
cloudwatchAlarm TopicRuleCloudwatchAlarmAction
Change the state of a CloudWatch alarm.
cloudwatchLogs TopicRuleCloudwatchLogsAction
Sends data to CloudWatch.
cloudwatchMetric TopicRuleCloudwatchMetricAction
Capture a CloudWatch metric.
dynamoDBv2 TopicRuleDynamoDBv2Action
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.
dynamoDb TopicRuleDynamoDbAction
Write to a DynamoDB table.
elasticsearch TopicRuleElasticsearchAction

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 the OpenSearch rule action instead. For more information, see OpenSearchAction .

firehose TopicRuleFirehoseAction
Write to an Amazon Kinesis Firehose stream.
http TopicRuleHttpAction
Send data to an HTTPS endpoint.
iotAnalytics TopicRuleIotAnalyticsAction
Sends message data to an AWS IoT Analytics channel.
iotEvents TopicRuleIotEventsAction
Sends an input to an AWS IoT Events detector.
iotSiteWise TopicRuleIotSiteWiseAction
Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
kafka TopicRuleKafkaAction
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
kinesis TopicRuleKinesisAction
Write data to an Amazon Kinesis stream.
lambda TopicRuleLambdaAction
Invoke a Lambda function.
location TopicRuleLocationAction
Sends device location data to Amazon Location Service .
openSearch TopicRuleOpenSearchAction
Write data to an Amazon OpenSearch Service domain.
republish TopicRuleRepublishAction
Publish to another MQTT topic.
s3 TopicRuleS3Action
Write to an Amazon S3 bucket.
sns TopicRuleSnsAction
Publish to an Amazon SNS topic.
sqs TopicRuleSqsAction
Publish to an Amazon SQS queue.
stepFunctions TopicRuleStepFunctionsAction
Starts execution of a Step Functions state machine.
timestream TopicRuleTimestreamAction
Writes attributes from an MQTT message.
cloudwatchAlarm TopicRuleCloudwatchAlarmAction
Change the state of a CloudWatch alarm.
cloudwatchLogs TopicRuleCloudwatchLogsAction
Sends data to CloudWatch.
cloudwatchMetric TopicRuleCloudwatchMetricAction
Capture a CloudWatch metric.
dynamoDBv2 TopicRuleDynamoDBv2Action
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.
dynamoDb TopicRuleDynamoDbAction
Write to a DynamoDB table.
elasticsearch TopicRuleElasticsearchAction

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 the OpenSearch rule action instead. For more information, see OpenSearchAction .

firehose TopicRuleFirehoseAction
Write to an Amazon Kinesis Firehose stream.
http TopicRuleHttpAction
Send data to an HTTPS endpoint.
iotAnalytics TopicRuleIotAnalyticsAction
Sends message data to an AWS IoT Analytics channel.
iotEvents TopicRuleIotEventsAction
Sends an input to an AWS IoT Events detector.
iotSiteWise TopicRuleIotSiteWiseAction
Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
kafka TopicRuleKafkaAction
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
kinesis TopicRuleKinesisAction
Write data to an Amazon Kinesis stream.
lambda TopicRuleLambdaAction
Invoke a Lambda function.
location TopicRuleLocationAction
Sends device location data to Amazon Location Service .
openSearch TopicRuleOpenSearchAction
Write data to an Amazon OpenSearch Service domain.
republish TopicRuleRepublishAction
Publish to another MQTT topic.
s3 TopicRuleS3Action
Write to an Amazon S3 bucket.
sns TopicRuleSnsAction
Publish to an Amazon SNS topic.
sqs TopicRuleSqsAction
Publish to an Amazon SQS queue.
stepFunctions TopicRuleStepFunctionsAction
Starts execution of a Step Functions state machine.
timestream TopicRuleTimestreamAction
Writes attributes from an MQTT message.
cloudwatch_alarm TopicRuleCloudwatchAlarmAction
Change the state of a CloudWatch alarm.
cloudwatch_logs TopicRuleCloudwatchLogsAction
Sends data to CloudWatch.
cloudwatch_metric TopicRuleCloudwatchMetricAction
Capture a CloudWatch metric.
dynamo_d_bv2 TopicRuleDynamoDBv2Action
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 TopicRuleDynamoDbAction
Write to a DynamoDB table.
elasticsearch TopicRuleElasticsearchAction

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 the OpenSearch rule action instead. For more information, see OpenSearchAction .

firehose TopicRuleFirehoseAction
Write to an Amazon Kinesis Firehose stream.
http TopicRuleHttpAction
Send data to an HTTPS endpoint.
iot_analytics TopicRuleIotAnalyticsAction
Sends message data to an AWS IoT Analytics channel.
iot_events TopicRuleIotEventsAction
Sends an input to an AWS IoT Events detector.
iot_site_wise TopicRuleIotSiteWiseAction
Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
kafka TopicRuleKafkaAction
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
kinesis TopicRuleKinesisAction
Write data to an Amazon Kinesis stream.
lambda_ TopicRuleLambdaAction
Invoke a Lambda function.
location TopicRuleLocationAction
Sends device location data to Amazon Location Service .
open_search TopicRuleOpenSearchAction
Write data to an Amazon OpenSearch Service domain.
republish TopicRuleRepublishAction
Publish to another MQTT topic.
s3 TopicRuleS3Action
Write to an Amazon S3 bucket.
sns TopicRuleSnsAction
Publish to an Amazon SNS topic.
sqs TopicRuleSqsAction
Publish to an Amazon SQS queue.
step_functions TopicRuleStepFunctionsAction
Starts execution of a Step Functions state machine.
timestream TopicRuleTimestreamAction
Writes attributes from an MQTT message.
cloudwatchAlarm Property Map
Change the state of a CloudWatch alarm.
cloudwatchLogs Property Map
Sends data to CloudWatch.
cloudwatchMetric Property Map
Capture a CloudWatch metric.
dynamoDBv2 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.
dynamoDb 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 the OpenSearch 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.
iotAnalytics Property Map
Sends message data to an AWS IoT Analytics channel.
iotEvents Property Map
Sends an input to an AWS IoT Events detector.
iotSiteWise Property Map
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 .
openSearch 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.
stepFunctions Property Map
Starts execution of a Step Functions state machine.
timestream Property Map
Writes attributes from an MQTT message.

TopicRuleAssetPropertyTimestamp
, TopicRuleAssetPropertyTimestampArgs

TimeInSeconds This property is required. string
A string that contains the time in seconds since epoch. Accepts substitution templates.
OffsetInNanos string
Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
TimeInSeconds This property is required. string
A string that contains the time in seconds since epoch. Accepts substitution templates.
OffsetInNanos string
Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
timeInSeconds This property is required. String
A string that contains the time in seconds since epoch. Accepts substitution templates.
offsetInNanos String
Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
timeInSeconds This property is required. string
A string that contains the time in seconds since epoch. Accepts substitution templates.
offsetInNanos string
Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
time_in_seconds This property is required. str
A string that contains the time in seconds since epoch. Accepts substitution templates.
offset_in_nanos str
Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
timeInSeconds This property is required. String
A string that contains the time in seconds since epoch. Accepts substitution templates.
offsetInNanos String
Optional. A string that contains the nanosecond time offset. Accepts substitution templates.

TopicRuleAssetPropertyValue
, TopicRuleAssetPropertyValueArgs

Timestamp This property is required. Pulumi.AwsNative.IoT.Inputs.TopicRuleAssetPropertyTimestamp
The asset property value timestamp.
Value This property is required. Pulumi.AwsNative.IoT.Inputs.TopicRuleAssetPropertyVariant
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 , or UNCERTAIN .
Timestamp This property is required. TopicRuleAssetPropertyTimestamp
The asset property value timestamp.
Value This property is required. TopicRuleAssetPropertyVariant
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 , or UNCERTAIN .
timestamp This property is required. TopicRuleAssetPropertyTimestamp
The asset property value timestamp.
value This property is required. TopicRuleAssetPropertyVariant
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 , or UNCERTAIN .
timestamp This property is required. TopicRuleAssetPropertyTimestamp
The asset property value timestamp.
value This property is required. TopicRuleAssetPropertyVariant
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 , or UNCERTAIN .
timestamp This property is required. TopicRuleAssetPropertyTimestamp
The asset property value timestamp.
value This property is required. TopicRuleAssetPropertyVariant
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 , or UNCERTAIN .
timestamp This property is required. Property Map
The asset property value timestamp.
value This property is required. 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 , or UNCERTAIN .

TopicRuleAssetPropertyVariant
, TopicRuleAssetPropertyVariantArgs

BooleanValue string
Optional. A string that contains the boolean value ( true or false ) of the value entry. Accepts substitution templates.
DoubleValue string
Optional. A string that contains the double value of the value entry. Accepts substitution templates.
IntegerValue string
Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
StringValue string
Optional. The string value of the value entry. Accepts substitution templates.
BooleanValue string
Optional. A string that contains the boolean value ( true or false ) of the value entry. Accepts substitution templates.
DoubleValue string
Optional. A string that contains the double value of the value entry. Accepts substitution templates.
IntegerValue string
Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
StringValue string
Optional. The string value of the value entry. Accepts substitution templates.
booleanValue String
Optional. A string that contains the boolean value ( true or false ) of the value entry. Accepts substitution templates.
doubleValue String
Optional. A string that contains the double value of the value entry. Accepts substitution templates.
integerValue String
Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
stringValue String
Optional. The string value of the value entry. Accepts substitution templates.
booleanValue string
Optional. A string that contains the boolean value ( true or false ) of the value entry. Accepts substitution templates.
doubleValue string
Optional. A string that contains the double value of the value entry. Accepts substitution templates.
integerValue string
Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
stringValue string
Optional. The string value of the value entry. Accepts substitution templates.
boolean_value str
Optional. A string that contains the boolean value ( true or false ) 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.
booleanValue String
Optional. A string that contains the boolean value ( true or false ) of the value entry. Accepts substitution templates.
doubleValue String
Optional. A string that contains the double value of the value entry. Accepts substitution templates.
integerValue String
Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
stringValue String
Optional. The string value of the value entry. Accepts substitution templates.

TopicRuleCannedAccessControlList
, TopicRuleCannedAccessControlListArgs

Private
private
PublicRead
public-read
PublicReadWrite
public-read-write
AwsExecRead
aws-exec-read
AuthenticatedRead
authenticated-read
BucketOwnerRead
bucket-owner-read
BucketOwnerFullControl
bucket-owner-full-control
LogDeliveryWrite
log-delivery-write
TopicRuleCannedAccessControlListPrivate
private
TopicRuleCannedAccessControlListPublicRead
public-read
TopicRuleCannedAccessControlListPublicReadWrite
public-read-write
TopicRuleCannedAccessControlListAwsExecRead
aws-exec-read
TopicRuleCannedAccessControlListAuthenticatedRead
authenticated-read
TopicRuleCannedAccessControlListBucketOwnerRead
bucket-owner-read
TopicRuleCannedAccessControlListBucketOwnerFullControl
bucket-owner-full-control
TopicRuleCannedAccessControlListLogDeliveryWrite
log-delivery-write
Private
private
PublicRead
public-read
PublicReadWrite
public-read-write
AwsExecRead
aws-exec-read
AuthenticatedRead
authenticated-read
BucketOwnerRead
bucket-owner-read
BucketOwnerFullControl
bucket-owner-full-control
LogDeliveryWrite
log-delivery-write
Private
private
PublicRead
public-read
PublicReadWrite
public-read-write
AwsExecRead
aws-exec-read
AuthenticatedRead
authenticated-read
BucketOwnerRead
bucket-owner-read
BucketOwnerFullControl
bucket-owner-full-control
LogDeliveryWrite
log-delivery-write
PRIVATE
private
PUBLIC_READ
public-read
PUBLIC_READ_WRITE
public-read-write
AWS_EXEC_READ
aws-exec-read
AUTHENTICATED_READ
authenticated-read
BUCKET_OWNER_READ
bucket-owner-read
BUCKET_OWNER_FULL_CONTROL
bucket-owner-full-control
LOG_DELIVERY_WRITE
log-delivery-write
"private"
private
"public-read"
public-read
"public-read-write"
public-read-write
"aws-exec-read"
aws-exec-read
"authenticated-read"
authenticated-read
"bucket-owner-read"
bucket-owner-read
"bucket-owner-full-control"
bucket-owner-full-control
"log-delivery-write"
log-delivery-write

TopicRuleCloudwatchAlarmAction
, TopicRuleCloudwatchAlarmActionArgs

AlarmName This property is required. string
The CloudWatch alarm name.
RoleArn This property is required. string
The IAM role that allows access to the CloudWatch alarm.
StateReason This property is required. string
The reason for the alarm change.
StateValue This property is required. string
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
AlarmName This property is required. string
The CloudWatch alarm name.
RoleArn This property is required. string
The IAM role that allows access to the CloudWatch alarm.
StateReason This property is required. string
The reason for the alarm change.
StateValue This property is required. string
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
alarmName This property is required. String
The CloudWatch alarm name.
roleArn This property is required. String
The IAM role that allows access to the CloudWatch alarm.
stateReason This property is required. String
The reason for the alarm change.
stateValue This property is required. String
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
alarmName This property is required. string
The CloudWatch alarm name.
roleArn This property is required. string
The IAM role that allows access to the CloudWatch alarm.
stateReason This property is required. string
The reason for the alarm change.
stateValue This property is required. string
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
alarm_name This property is required. str
The CloudWatch alarm name.
role_arn This property is required. str
The IAM role that allows access to the CloudWatch alarm.
state_reason This property is required. str
The reason for the alarm change.
state_value This property is required. str
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
alarmName This property is required. String
The CloudWatch alarm name.
roleArn This property is required. String
The IAM role that allows access to the CloudWatch alarm.
stateReason This property is required. String
The reason for the alarm change.
stateValue This property is required. String
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

TopicRuleCloudwatchLogsAction
, TopicRuleCloudwatchLogsActionArgs

LogGroupName This property is required. string
The CloudWatch log name.
RoleArn This property is required. string
The IAM role that allows access to the CloudWatch log.
BatchMode bool
Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
LogGroupName This property is required. string
The CloudWatch log name.
RoleArn This property is required. string
The IAM role that allows access to the CloudWatch log.
BatchMode bool
Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
logGroupName This property is required. String
The CloudWatch log name.
roleArn This property is required. String
The IAM role that allows access to the CloudWatch log.
batchMode Boolean
Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
logGroupName This property is required. string
The CloudWatch log name.
roleArn This property is required. string
The IAM role that allows access to the CloudWatch log.
batchMode boolean
Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
log_group_name This property is required. str
The CloudWatch log name.
role_arn This property is required. 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.
logGroupName This property is required. String
The CloudWatch log name.
roleArn This property is required. String
The IAM role that allows access to the CloudWatch log.
batchMode Boolean
Indicates whether batches of log records will be extracted and uploaded into CloudWatch.

TopicRuleCloudwatchMetricAction
, TopicRuleCloudwatchMetricActionArgs

MetricName This property is required. string
The CloudWatch metric name.
MetricNamespace This property is required. string
The CloudWatch metric namespace name.
MetricUnit This property is required. string
The metric unit supported by CloudWatch.
MetricValue This property is required. string
The CloudWatch metric value.
RoleArn This property is required. string
The IAM role that allows access to the CloudWatch metric.
MetricTimestamp string
An optional Unix timestamp .
MetricName This property is required. string
The CloudWatch metric name.
MetricNamespace This property is required. string
The CloudWatch metric namespace name.
MetricUnit This property is required. string
The metric unit supported by CloudWatch.
MetricValue This property is required. string
The CloudWatch metric value.
RoleArn This property is required. string
The IAM role that allows access to the CloudWatch metric.
MetricTimestamp string
An optional Unix timestamp .
metricName This property is required. String
The CloudWatch metric name.
metricNamespace This property is required. String
The CloudWatch metric namespace name.
metricUnit This property is required. String
The metric unit supported by CloudWatch.
metricValue This property is required. String
The CloudWatch metric value.
roleArn This property is required. String
The IAM role that allows access to the CloudWatch metric.
metricTimestamp String
An optional Unix timestamp .
metricName This property is required. string
The CloudWatch metric name.
metricNamespace This property is required. string
The CloudWatch metric namespace name.
metricUnit This property is required. string
The metric unit supported by CloudWatch.
metricValue This property is required. string
The CloudWatch metric value.
roleArn This property is required. string
The IAM role that allows access to the CloudWatch metric.
metricTimestamp string
An optional Unix timestamp .
metric_name This property is required. str
The CloudWatch metric name.
metric_namespace This property is required. str
The CloudWatch metric namespace name.
metric_unit This property is required. str
The metric unit supported by CloudWatch.
metric_value This property is required. str
The CloudWatch metric value.
role_arn This property is required. str
The IAM role that allows access to the CloudWatch metric.
metric_timestamp str
An optional Unix timestamp .
metricName This property is required. String
The CloudWatch metric name.
metricNamespace This property is required. String
The CloudWatch metric namespace name.
metricUnit This property is required. String
The metric unit supported by CloudWatch.
metricValue This property is required. String
The CloudWatch metric value.
roleArn This property is required. String
The IAM role that allows access to the CloudWatch metric.
metricTimestamp String
An optional Unix timestamp .

TopicRuleDynamoDBv2Action
, TopicRuleDynamoDBv2ActionArgs

PutItem Pulumi.AwsNative.IoT.Inputs.TopicRulePutItemInput

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.

RoleArn string
The ARN of the IAM role that grants access to the DynamoDB table.
PutItem TopicRulePutItemInput

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.

RoleArn string
The ARN of the IAM role that grants access to the DynamoDB table.
putItem TopicRulePutItemInput

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.

roleArn String
The ARN of the IAM role that grants access to the DynamoDB table.
putItem TopicRulePutItemInput

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.

roleArn string
The ARN of the IAM role that grants access to the DynamoDB table.
put_item TopicRulePutItemInput

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

roleArn String
The ARN of the IAM role that grants access to the DynamoDB table.

TopicRuleDynamoDbAction
, TopicRuleDynamoDbActionArgs

HashKeyField This property is required. string
The hash key name.
HashKeyValue This property is required. string
The hash key value.
RoleArn This property is required. string
The ARN of the IAM role that grants access to the DynamoDB table.
TableName This property is required. string
The name of the DynamoDB table.
HashKeyType string
The hash key type. Valid values are "STRING" or "NUMBER"
PayloadField string
The action payload. This name can be customized.
RangeKeyField string
The range key name.
RangeKeyType string
The range key type. Valid values are "STRING" or "NUMBER"
RangeKeyValue string
The range key value.
HashKeyField This property is required. string
The hash key name.
HashKeyValue This property is required. string
The hash key value.
RoleArn This property is required. string
The ARN of the IAM role that grants access to the DynamoDB table.
TableName This property is required. string
The name of the DynamoDB table.
HashKeyType string
The hash key type. Valid values are "STRING" or "NUMBER"
PayloadField string
The action payload. This name can be customized.
RangeKeyField string
The range key name.
RangeKeyType string
The range key type. Valid values are "STRING" or "NUMBER"
RangeKeyValue string
The range key value.
hashKeyField This property is required. String
The hash key name.
hashKeyValue This property is required. String
The hash key value.
roleArn This property is required. String
The ARN of the IAM role that grants access to the DynamoDB table.
tableName This property is required. String
The name of the DynamoDB table.
hashKeyType String
The hash key type. Valid values are "STRING" or "NUMBER"
payloadField String
The action payload. This name can be customized.
rangeKeyField String
The range key name.
rangeKeyType String
The range key type. Valid values are "STRING" or "NUMBER"
rangeKeyValue String
The range key value.
hashKeyField This property is required. string
The hash key name.
hashKeyValue This property is required. string
The hash key value.
roleArn This property is required. string
The ARN of the IAM role that grants access to the DynamoDB table.
tableName This property is required. string
The name of the DynamoDB table.
hashKeyType string
The hash key type. Valid values are "STRING" or "NUMBER"
payloadField string
The action payload. This name can be customized.
rangeKeyField string
The range key name.
rangeKeyType string
The range key type. Valid values are "STRING" or "NUMBER"
rangeKeyValue string
The range key value.
hash_key_field This property is required. str
The hash key name.
hash_key_value This property is required. str
The hash key value.
role_arn This property is required. str
The ARN of the IAM role that grants access to the DynamoDB table.
table_name This property is required. str
The name of the DynamoDB table.
hash_key_type str
The hash key type. Valid values are "STRING" or "NUMBER"
payload_field str
The action payload. This name can be customized.
range_key_field str
The range key name.
range_key_type str
The range key type. Valid values are "STRING" or "NUMBER"
range_key_value str
The range key value.
hashKeyField This property is required. String
The hash key name.
hashKeyValue This property is required. String
The hash key value.
roleArn This property is required. String
The ARN of the IAM role that grants access to the DynamoDB table.
tableName This property is required. String
The name of the DynamoDB table.
hashKeyType String
The hash key type. Valid values are "STRING" or "NUMBER"
payloadField String
The action payload. This name can be customized.
rangeKeyField String
The range key name.
rangeKeyType String
The range key type. Valid values are "STRING" or "NUMBER"
rangeKeyValue String
The range key value.

TopicRuleElasticsearchAction
, TopicRuleElasticsearchActionArgs

Endpoint This property is required. string
The endpoint of your OpenSearch domain.
Id This property is required. string
The unique identifier for the document you are storing.
Index This property is required. string
The index where you want to store your data.
RoleArn This property is required. string
The IAM role ARN that has access to OpenSearch.
Type This property is required. string
The type of document you are storing.
Endpoint This property is required. string
The endpoint of your OpenSearch domain.
Id This property is required. string
The unique identifier for the document you are storing.
Index This property is required. string
The index where you want to store your data.
RoleArn This property is required. string
The IAM role ARN that has access to OpenSearch.
Type This property is required. string
The type of document you are storing.
endpoint This property is required. String
The endpoint of your OpenSearch domain.
id This property is required. String
The unique identifier for the document you are storing.
index This property is required. String
The index where you want to store your data.
roleArn This property is required. String
The IAM role ARN that has access to OpenSearch.
type This property is required. String
The type of document you are storing.
endpoint This property is required. string
The endpoint of your OpenSearch domain.
id This property is required. string
The unique identifier for the document you are storing.
index This property is required. string
The index where you want to store your data.
roleArn This property is required. string
The IAM role ARN that has access to OpenSearch.
type This property is required. string
The type of document you are storing.
endpoint This property is required. str
The endpoint of your OpenSearch domain.
id This property is required. str
The unique identifier for the document you are storing.
index This property is required. str
The index where you want to store your data.
role_arn This property is required. str
The IAM role ARN that has access to OpenSearch.
type This property is required. str
The type of document you are storing.
endpoint This property is required. String
The endpoint of your OpenSearch domain.
id This property is required. String
The unique identifier for the document you are storing.
index This property is required. String
The index where you want to store your data.
roleArn This property is required. String
The IAM role ARN that has access to OpenSearch.
type This property is required. String
The type of document you are storing.

TopicRuleFirehoseAction
, TopicRuleFirehoseActionArgs

DeliveryStreamName This property is required. string
The delivery stream name.
RoleArn This property is required. string
The IAM role that grants access to the Amazon Kinesis Firehose stream.
BatchMode bool

Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false .

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch 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).
DeliveryStreamName This property is required. string
The delivery stream name.
RoleArn This property is required. string
The IAM role that grants access to the Amazon Kinesis Firehose stream.
BatchMode bool

Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false .

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch 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).
deliveryStreamName This property is required. String
The delivery stream name.
roleArn This property is required. String
The IAM role that grants access to the Amazon Kinesis Firehose stream.
batchMode Boolean

Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false .

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch 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).
deliveryStreamName This property is required. string
The delivery stream name.
roleArn This property is required. string
The IAM role that grants access to the Amazon Kinesis Firehose stream.
batchMode boolean

Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false .

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch 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_name This property is required. str
The delivery stream name.
role_arn This property is required. 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 is false .

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch 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).
deliveryStreamName This property is required. String
The delivery stream name.
roleArn This property is required. String
The IAM role that grants access to the Amazon Kinesis Firehose stream.
batchMode Boolean

Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch . The default value is false .

When batchMode is true and the rule's SQL statement evaluates to an Array, each Array element forms one record in the PutRecordBatch 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
, TopicRuleHttpActionArgs

Url This property is required. 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 new TopicRuleDestination is created if possible.
Auth Pulumi.AwsNative.IoT.Inputs.TopicRuleHttpAuthorization
The authentication method to use when sending data to an HTTPS endpoint.
ConfirmationUrl 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.AwsNative.IoT.Inputs.TopicRuleHttpActionHeader>
The HTTP headers to send with the message data.
Url This property is required. 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 new TopicRuleDestination is created if possible.
Auth TopicRuleHttpAuthorization
The authentication method to use when sending data to an HTTPS endpoint.
ConfirmationUrl 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 []TopicRuleHttpActionHeader
The HTTP headers to send with the message data.
url This property is required. 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 new TopicRuleDestination is created if possible.
auth TopicRuleHttpAuthorization
The authentication method to use when sending data to an HTTPS endpoint.
confirmationUrl 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<TopicRuleHttpActionHeader>
The HTTP headers to send with the message data.
url This property is required. 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 new TopicRuleDestination is created if possible.
auth TopicRuleHttpAuthorization
The authentication method to use when sending data to an HTTPS endpoint.
confirmationUrl 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 TopicRuleHttpActionHeader[]
The HTTP headers to send with the message data.
url This property is required. 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 new TopicRuleDestination is created if possible.
auth TopicRuleHttpAuthorization
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[TopicRuleHttpActionHeader]
The HTTP headers to send with the message data.
url This property is required. 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 new TopicRuleDestination is created if possible.
auth Property Map
The authentication method to use when sending data to an HTTPS endpoint.
confirmationUrl 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
, TopicRuleHttpActionHeaderArgs

Key This property is required. string
The HTTP header key.
Value This property is required. string
The HTTP header value. Substitution templates are supported.
Key This property is required. string
The HTTP header key.
Value This property is required. string
The HTTP header value. Substitution templates are supported.
key This property is required. String
The HTTP header key.
value This property is required. String
The HTTP header value. Substitution templates are supported.
key This property is required. string
The HTTP header key.
value This property is required. string
The HTTP header value. Substitution templates are supported.
key This property is required. str
The HTTP header key.
value This property is required. str
The HTTP header value. Substitution templates are supported.
key This property is required. String
The HTTP header key.
value This property is required. String
The HTTP header value. Substitution templates are supported.

TopicRuleHttpAuthorization
, TopicRuleHttpAuthorizationArgs

Sigv4 TopicRuleSigV4Authorization
Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .
sigv4 TopicRuleSigV4Authorization
Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .
sigv4 TopicRuleSigV4Authorization
Use Sig V4 authorization. For more information, see Signature Version 4 Signing Process .
sigv4 TopicRuleSigV4Authorization
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
, TopicRuleIotAnalyticsActionArgs

ChannelName This property is required. string
The name of the IoT Analytics channel to which message data will be sent.
RoleArn This property is required. string
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
BatchMode bool

Whether to process the action as a batch. The default value is false .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage The resulting array can't have more than 100 messages.

ChannelName This property is required. string
The name of the IoT Analytics channel to which message data will be sent.
RoleArn This property is required. string
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
BatchMode bool

Whether to process the action as a batch. The default value is false .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage The resulting array can't have more than 100 messages.

channelName This property is required. String
The name of the IoT Analytics channel to which message data will be sent.
roleArn This property is required. String
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
batchMode Boolean

Whether to process the action as a batch. The default value is false .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage The resulting array can't have more than 100 messages.

channelName This property is required. string
The name of the IoT Analytics channel to which message data will be sent.
roleArn This property is required. string
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
batchMode boolean

Whether to process the action as a batch. The default value is false .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage The resulting array can't have more than 100 messages.

channel_name This property is required. str
The name of the IoT Analytics channel to which message data will be sent.
role_arn This property is required. 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 is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage The resulting array can't have more than 100 messages.

channelName This property is required. String
The name of the IoT Analytics channel to which message data will be sent.
roleArn This property is required. String
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
batchMode Boolean

Whether to process the action as a batch. The default value is false .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by BatchPutMessage The resulting array can't have more than 100 messages.

TopicRuleIotEventsAction
, TopicRuleIotEventsActionArgs

InputName This property is required. string
The name of the AWS IoT Events input.
RoleArn This property is required. string
The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
BatchMode bool

Whether to process the event actions as a batch. The default value is false .

When batchMode is true , you can't specify a messageId .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

MessageId string

The ID of the message. The default messageId is a new UUID value.

When batchMode is true , you can't specify a messageId --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.

InputName This property is required. string
The name of the AWS IoT Events input.
RoleArn This property is required. string
The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
BatchMode bool

Whether to process the event actions as a batch. The default value is false .

When batchMode is true , you can't specify a messageId .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

MessageId string

The ID of the message. The default messageId is a new UUID value.

When batchMode is true , you can't specify a messageId --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.

inputName This property is required. String
The name of the AWS IoT Events input.
roleArn This property is required. String
The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
batchMode Boolean

Whether to process the event actions as a batch. The default value is false .

When batchMode is true , you can't specify a messageId .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

messageId String

The ID of the message. The default messageId is a new UUID value.

When batchMode is true , you can't specify a messageId --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.

inputName This property is required. string
The name of the AWS IoT Events input.
roleArn This property is required. string
The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
batchMode boolean

Whether to process the event actions as a batch. The default value is false .

When batchMode is true , you can't specify a messageId .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

messageId string

The ID of the message. The default messageId is a new UUID value.

When batchMode is true , you can't specify a messageId --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 This property is required. str
The name of the AWS IoT Events input.
role_arn This property is required. 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 is true , you can't specify a messageId .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling BatchPutMessage . 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 is true , you can't specify a messageId --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.

inputName This property is required. String
The name of the AWS IoT Events input.
roleArn This property is required. String
The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
batchMode Boolean

Whether to process the event actions as a batch. The default value is false .

When batchMode is true , you can't specify a messageId .

When batchMode is true and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling BatchPutMessage . The resulting array can't have more than 10 messages.

messageId String

The ID of the message. The default messageId is a new UUID value.

When batchMode is true , you can't specify a messageId --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
, TopicRuleIotSiteWiseActionArgs

PutAssetPropertyValueEntries This property is required. List<Pulumi.AwsNative.IoT.Inputs.TopicRulePutAssetPropertyValueEntry>
A list of asset property value entries.
RoleArn This property is required. 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.
PutAssetPropertyValueEntries This property is required. []TopicRulePutAssetPropertyValueEntry
A list of asset property value entries.
RoleArn This property is required. 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.
putAssetPropertyValueEntries This property is required. List<TopicRulePutAssetPropertyValueEntry>
A list of asset property value entries.
roleArn This property is required. 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.
putAssetPropertyValueEntries This property is required. TopicRulePutAssetPropertyValueEntry[]
A list of asset property value entries.
roleArn This property is required. 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_property_value_entries This property is required. Sequence[TopicRulePutAssetPropertyValueEntry]
A list of asset property value entries.
role_arn This property is required. 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.
putAssetPropertyValueEntries This property is required. List<Property Map>
A list of asset property value entries.
roleArn This property is required. 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
, TopicRuleKafkaActionArgs

ClientProperties This property is required. Dictionary<string, string>
Properties of the Apache Kafka producer client.
DestinationArn This property is required. string
The ARN of Kafka action's VPC TopicRuleDestination .
Topic This property is required. string
The Kafka topic for messages to be sent to the Kafka broker.
Headers List<Pulumi.AwsNative.IoT.Inputs.TopicRuleKafkaActionHeader>
The list of Kafka headers that you specify.
Key string
The Kafka message key.
Partition string
The Kafka message partition.
ClientProperties This property is required. map[string]string
Properties of the Apache Kafka producer client.
DestinationArn This property is required. string
The ARN of Kafka action's VPC TopicRuleDestination .
Topic This property is required. string
The Kafka topic for messages to be sent to the Kafka broker.
Headers []TopicRuleKafkaActionHeader
The list of Kafka headers that you specify.
Key string
The Kafka message key.
Partition string
The Kafka message partition.
clientProperties This property is required. Map<String,String>
Properties of the Apache Kafka producer client.
destinationArn This property is required. String
The ARN of Kafka action's VPC TopicRuleDestination .
topic This property is required. String
The Kafka topic for messages to be sent to the Kafka broker.
headers List<TopicRuleKafkaActionHeader>
The list of Kafka headers that you specify.
key String
The Kafka message key.
partition String
The Kafka message partition.
clientProperties This property is required. {[key: string]: string}
Properties of the Apache Kafka producer client.
destinationArn This property is required. string
The ARN of Kafka action's VPC TopicRuleDestination .
topic This property is required. string
The Kafka topic for messages to be sent to the Kafka broker.
headers TopicRuleKafkaActionHeader[]
The list of Kafka headers that you specify.
key string
The Kafka message key.
partition string
The Kafka message partition.
client_properties This property is required. Mapping[str, str]
Properties of the Apache Kafka producer client.
destination_arn This property is required. str
The ARN of Kafka action's VPC TopicRuleDestination .
topic This property is required. str
The Kafka topic for messages to be sent to the Kafka broker.
headers Sequence[TopicRuleKafkaActionHeader]
The list of Kafka headers that you specify.
key str
The Kafka message key.
partition str
The Kafka message partition.
clientProperties This property is required. Map<String>
Properties of the Apache Kafka producer client.
destinationArn This property is required. String
The ARN of Kafka action's VPC TopicRuleDestination .
topic This property is required. 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
, TopicRuleKafkaActionHeaderArgs

Key This property is required. string
The key of the Kafka header.
Value This property is required. string
The value of the Kafka header.
Key This property is required. string
The key of the Kafka header.
Value This property is required. string
The value of the Kafka header.
key This property is required. String
The key of the Kafka header.
value This property is required. String
The value of the Kafka header.
key This property is required. string
The key of the Kafka header.
value This property is required. string
The value of the Kafka header.
key This property is required. str
The key of the Kafka header.
value This property is required. str
The value of the Kafka header.
key This property is required. String
The key of the Kafka header.
value This property is required. String
The value of the Kafka header.

TopicRuleKinesisAction
, TopicRuleKinesisActionArgs

RoleArn This property is required. string
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
StreamName This property is required. string
The name of the Amazon Kinesis stream.
PartitionKey string
The partition key.
RoleArn This property is required. string
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
StreamName This property is required. string
The name of the Amazon Kinesis stream.
PartitionKey string
The partition key.
roleArn This property is required. String
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
streamName This property is required. String
The name of the Amazon Kinesis stream.
partitionKey String
The partition key.
roleArn This property is required. string
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
streamName This property is required. string
The name of the Amazon Kinesis stream.
partitionKey string
The partition key.
role_arn This property is required. str
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
stream_name This property is required. str
The name of the Amazon Kinesis stream.
partition_key str
The partition key.
roleArn This property is required. String
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
streamName This property is required. String
The name of the Amazon Kinesis stream.
partitionKey String
The partition key.

TopicRuleLambdaAction
, TopicRuleLambdaActionArgs

FunctionArn string
The ARN of the Lambda function.
FunctionArn string
The ARN of the Lambda function.
functionArn String
The ARN of the Lambda function.
functionArn string
The ARN of the Lambda function.
function_arn str
The ARN of the Lambda function.
functionArn String
The ARN of the Lambda function.

TopicRuleLocationAction
, TopicRuleLocationActionArgs

DeviceId This property is required. string
The unique ID of the device providing the location data.
Latitude This property is required. string
A string that evaluates to a double value that represents the latitude of the device's location.
Longitude This property is required. string
A string that evaluates to a double value that represents the longitude of the device's location.
RoleArn This property is required. string
The IAM role that grants permission to write to the Amazon Location resource.
TrackerName This property is required. string
The name of the tracker resource in Amazon Location in which the location is updated.
Timestamp Pulumi.AwsNative.IoT.Inputs.TopicRuleTimestamp
The time that the location data was sampled. The default value is the time the MQTT message was processed.
DeviceId This property is required. string
The unique ID of the device providing the location data.
Latitude This property is required. string
A string that evaluates to a double value that represents the latitude of the device's location.
Longitude This property is required. string
A string that evaluates to a double value that represents the longitude of the device's location.
RoleArn This property is required. string
The IAM role that grants permission to write to the Amazon Location resource.
TrackerName This property is required. string
The name of the tracker resource in Amazon Location in which the location is updated.
Timestamp TopicRuleTimestamp
The time that the location data was sampled. The default value is the time the MQTT message was processed.
deviceId This property is required. String
The unique ID of the device providing the location data.
latitude This property is required. String
A string that evaluates to a double value that represents the latitude of the device's location.
longitude This property is required. String
A string that evaluates to a double value that represents the longitude of the device's location.
roleArn This property is required. String
The IAM role that grants permission to write to the Amazon Location resource.
trackerName This property is required. String
The name of the tracker resource in Amazon Location in which the location is updated.
timestamp TopicRuleTimestamp
The time that the location data was sampled. The default value is the time the MQTT message was processed.
deviceId This property is required. string
The unique ID of the device providing the location data.
latitude This property is required. string
A string that evaluates to a double value that represents the latitude of the device's location.
longitude This property is required. string
A string that evaluates to a double value that represents the longitude of the device's location.
roleArn This property is required. string
The IAM role that grants permission to write to the Amazon Location resource.
trackerName This property is required. string
The name of the tracker resource in Amazon Location in which the location is updated.
timestamp TopicRuleTimestamp
The time that the location data was sampled. The default value is the time the MQTT message was processed.
device_id This property is required. str
The unique ID of the device providing the location data.
latitude This property is required. str
A string that evaluates to a double value that represents the latitude of the device's location.
longitude This property is required. str
A string that evaluates to a double value that represents the longitude of the device's location.
role_arn This property is required. str
The IAM role that grants permission to write to the Amazon Location resource.
tracker_name This property is required. str
The name of the tracker resource in Amazon Location in which the location is updated.
timestamp TopicRuleTimestamp
The time that the location data was sampled. The default value is the time the MQTT message was processed.
deviceId This property is required. String
The unique ID of the device providing the location data.
latitude This property is required. String
A string that evaluates to a double value that represents the latitude of the device's location.
longitude This property is required. String
A string that evaluates to a double value that represents the longitude of the device's location.
roleArn This property is required. String
The IAM role that grants permission to write to the Amazon Location resource.
trackerName This property is required. 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
, TopicRuleOpenSearchActionArgs

Endpoint This property is required. string
The endpoint of your OpenSearch domain.
Id This property is required. string
The unique identifier for the document you are storing.
Index This property is required. string
The OpenSearch index where you want to store your data.
RoleArn This property is required. string
The IAM role ARN that has access to OpenSearch.
Type This property is required. string
The type of document you are storing.
Endpoint This property is required. string
The endpoint of your OpenSearch domain.
Id This property is required. string
The unique identifier for the document you are storing.
Index This property is required. string
The OpenSearch index where you want to store your data.
RoleArn This property is required. string
The IAM role ARN that has access to OpenSearch.
Type This property is required. string
The type of document you are storing.
endpoint This property is required. String
The endpoint of your OpenSearch domain.
id This property is required. String
The unique identifier for the document you are storing.
index This property is required. String
The OpenSearch index where you want to store your data.
roleArn This property is required. String
The IAM role ARN that has access to OpenSearch.
type This property is required. String
The type of document you are storing.
endpoint This property is required. string
The endpoint of your OpenSearch domain.
id This property is required. string
The unique identifier for the document you are storing.
index This property is required. string
The OpenSearch index where you want to store your data.
roleArn This property is required. string
The IAM role ARN that has access to OpenSearch.
type This property is required. string
The type of document you are storing.
endpoint This property is required. str
The endpoint of your OpenSearch domain.
id This property is required. str
The unique identifier for the document you are storing.
index This property is required. str
The OpenSearch index where you want to store your data.
role_arn This property is required. str
The IAM role ARN that has access to OpenSearch.
type This property is required. str
The type of document you are storing.
endpoint This property is required. String
The endpoint of your OpenSearch domain.
id This property is required. String
The unique identifier for the document you are storing.
index This property is required. String
The OpenSearch index where you want to store your data.
roleArn This property is required. String
The IAM role ARN that has access to OpenSearch.
type This property is required. String
The type of document you are storing.

TopicRulePayload
, TopicRulePayloadArgs

Actions This property is required. List<Pulumi.AwsNative.IoT.Inputs.TopicRuleAction>
The actions associated with the rule.
Sql This property is required. string
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
AwsIotSqlVersion string

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.
ErrorAction Pulumi.AwsNative.IoT.Inputs.TopicRuleAction
The action to take when an error occurs.
RuleDisabled bool
Specifies whether the rule is disabled.
Actions This property is required. []TopicRuleAction
The actions associated with the rule.
Sql This property is required. string
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
AwsIotSqlVersion string

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.
ErrorAction TopicRuleAction
The action to take when an error occurs.
RuleDisabled bool
Specifies whether the rule is disabled.
actions This property is required. List<TopicRuleAction>
The actions associated with the rule.
sql This property is required. String
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
awsIotSqlVersion String

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.
errorAction TopicRuleAction
The action to take when an error occurs.
ruleDisabled Boolean
Specifies whether the rule is disabled.
actions This property is required. TopicRuleAction[]
The actions associated with the rule.
sql This property is required. string
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
awsIotSqlVersion string

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.
errorAction TopicRuleAction
The action to take when an error occurs.
ruleDisabled boolean
Specifies whether the rule is disabled.
actions This property is required. Sequence[TopicRuleAction]
The actions associated with the rule.
sql This property is required. 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_sql_version str

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 TopicRuleAction
The action to take when an error occurs.
rule_disabled bool
Specifies whether the rule is disabled.
actions This property is required. List<Property Map>
The actions associated with the rule.
sql This property is required. String
The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
awsIotSqlVersion String

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.
errorAction Property Map
The action to take when an error occurs.
ruleDisabled Boolean
Specifies whether the rule is disabled.

TopicRulePutAssetPropertyValueEntry
, TopicRulePutAssetPropertyValueEntryArgs

PropertyValues This property is required. List<Pulumi.AwsNative.IoT.Inputs.TopicRuleAssetPropertyValue>
A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
AssetId string
The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
EntryId 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.
PropertyAlias string
The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
PropertyId string
The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
PropertyValues This property is required. []TopicRuleAssetPropertyValue
A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
AssetId string
The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
EntryId 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.
PropertyAlias string
The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
PropertyId string
The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
propertyValues This property is required. List<TopicRuleAssetPropertyValue>
A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
assetId String
The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
entryId 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.
propertyAlias String
The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
propertyId String
The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
propertyValues This property is required. TopicRuleAssetPropertyValue[]
A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
assetId string
The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
entryId 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.
propertyAlias string
The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
propertyId string
The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
property_values This property is required. Sequence[TopicRuleAssetPropertyValue]
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 an aliasId and a propertyId . 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 an aliasId and a propertyId . Accepts substitution templates.
property_id str
The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
propertyValues This property is required. List<Property Map>
A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
assetId String
The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
entryId 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.
propertyAlias String
The name of the property alias associated with your asset property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.
propertyId String
The ID of the asset's property. You must specify either a propertyAlias or both an aliasId and a propertyId . Accepts substitution templates.

TopicRulePutItemInput
, TopicRulePutItemInputArgs

TableName This property is required. string
The table where the message data will be written.
TableName This property is required. string
The table where the message data will be written.
tableName This property is required. String
The table where the message data will be written.
tableName This property is required. string
The table where the message data will be written.
table_name This property is required. str
The table where the message data will be written.
tableName This property is required. String
The table where the message data will be written.

TopicRuleRepublishAction
, TopicRuleRepublishActionArgs

RoleArn This property is required. string
The ARN of the IAM role that grants access.
Topic This property is required. string
The name of the MQTT topic.
Headers Pulumi.AwsNative.IoT.Inputs.TopicRuleRepublishActionHeaders
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.
RoleArn This property is required. string
The ARN of the IAM role that grants access.
Topic This property is required. string
The name of the MQTT topic.
Headers TopicRuleRepublishActionHeaders
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.
roleArn This property is required. String
The ARN of the IAM role that grants access.
topic This property is required. String
The name of the MQTT topic.
headers TopicRuleRepublishActionHeaders
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.
roleArn This property is required. string
The ARN of the IAM role that grants access.
topic This property is required. string
The name of the MQTT topic.
headers TopicRuleRepublishActionHeaders
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 This property is required. str
The ARN of the IAM role that grants access.
topic This property is required. str
The name of the MQTT topic.
headers TopicRuleRepublishActionHeaders
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.
roleArn This property is required. String
The ARN of the IAM role that grants access.
topic This property is required. 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
, TopicRuleRepublishActionHeadersArgs

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

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

MessageExpiry 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 of messageExpiry , see Message broker and protocol limits and quotas in the IoT Core Reference Guide.

Supports substitution templates .

PayloadFormatIndicator string

An Enum string value that indicates whether the payload is formatted as UTF-8.

Valid values are UNSPECIFIED_BYTES and UTF8_DATA .

For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.

Supports substitution templates .

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

UserProperties List<Pulumi.AwsNative.IoT.Inputs.TopicRuleUserProperty>
An array of key-value pairs that you define in the MQTT5 header.
ContentType 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 .

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

MessageExpiry 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 of messageExpiry , see Message broker and protocol limits and quotas in the IoT Core Reference Guide.

Supports substitution templates .

PayloadFormatIndicator string

An Enum string value that indicates whether the payload is formatted as UTF-8.

Valid values are UNSPECIFIED_BYTES and UTF8_DATA .

For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.

Supports substitution templates .

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

UserProperties []TopicRuleUserProperty
An array of key-value pairs that you define in the MQTT5 header.
contentType 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 .

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

messageExpiry 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 of messageExpiry , see Message broker and protocol limits and quotas in the IoT Core Reference Guide.

Supports substitution templates .

payloadFormatIndicator String

An Enum string value that indicates whether the payload is formatted as UTF-8.

Valid values are UNSPECIFIED_BYTES and UTF8_DATA .

For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.

Supports substitution templates .

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

userProperties List<TopicRuleUserProperty>
An array of key-value pairs that you define in the MQTT5 header.
contentType 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 .

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

messageExpiry 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 of messageExpiry , see Message broker and protocol limits and quotas in the IoT Core Reference Guide.

Supports substitution templates .

payloadFormatIndicator string

An Enum string value that indicates whether the payload is formatted as UTF-8.

Valid values are UNSPECIFIED_BYTES and UTF8_DATA .

For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.

Supports substitution templates .

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

userProperties TopicRuleUserProperty[]
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 of messageExpiry , see Message broker and protocol limits and quotas in the IoT Core Reference Guide.

Supports substitution templates .

payload_format_indicator str

An Enum string value that indicates whether the payload is formatted as UTF-8.

Valid values are UNSPECIFIED_BYTES and UTF8_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[TopicRuleUserProperty]
An array of key-value pairs that you define in the MQTT5 header.
contentType 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 .

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

messageExpiry 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 of messageExpiry , see Message broker and protocol limits and quotas in the IoT Core Reference Guide.

Supports substitution templates .

payloadFormatIndicator String

An Enum string value that indicates whether the payload is formatted as UTF-8.

Valid values are UNSPECIFIED_BYTES and UTF8_DATA .

For more information, see Payload Format Indicator from the MQTT Version 5.0 specification.

Supports substitution templates .

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

userProperties List<Property Map>
An array of key-value pairs that you define in the MQTT5 header.

TopicRuleS3Action
, TopicRuleS3ActionArgs

BucketName This property is required. string
The Amazon S3 bucket.
Key This property is required. string
The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
RoleArn This property is required. string
The ARN of the IAM role that grants access.
CannedAcl Pulumi.AwsNative.IoT.TopicRuleCannedAccessControlList
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
BucketName This property is required. string
The Amazon S3 bucket.
Key This property is required. string
The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
RoleArn This property is required. string
The ARN of the IAM role that grants access.
CannedAcl TopicRuleCannedAccessControlList
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
bucketName This property is required. String
The Amazon S3 bucket.
key This property is required. String
The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
roleArn This property is required. String
The ARN of the IAM role that grants access.
cannedAcl TopicRuleCannedAccessControlList
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
bucketName This property is required. string
The Amazon S3 bucket.
key This property is required. string
The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
roleArn This property is required. string
The ARN of the IAM role that grants access.
cannedAcl TopicRuleCannedAccessControlList
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 This property is required. str
The Amazon S3 bucket.
key This property is required. str
The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
role_arn This property is required. str
The ARN of the IAM role that grants access.
canned_acl TopicRuleCannedAccessControlList
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs .
bucketName This property is required. String
The Amazon S3 bucket.
key This property is required. String
The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
roleArn This property is required. String
The ARN of the IAM role that grants access.
cannedAcl "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
, TopicRuleSigV4AuthorizationArgs

RoleArn This property is required. string
The ARN of the signing role.
ServiceName This property is required. string
The service name to use while signing with Sig V4.
SigningRegion This property is required. string
The signing region.
RoleArn This property is required. string
The ARN of the signing role.
ServiceName This property is required. string
The service name to use while signing with Sig V4.
SigningRegion This property is required. string
The signing region.
roleArn This property is required. String
The ARN of the signing role.
serviceName This property is required. String
The service name to use while signing with Sig V4.
signingRegion This property is required. String
The signing region.
roleArn This property is required. string
The ARN of the signing role.
serviceName This property is required. string
The service name to use while signing with Sig V4.
signingRegion This property is required. string
The signing region.
role_arn This property is required. str
The ARN of the signing role.
service_name This property is required. str
The service name to use while signing with Sig V4.
signing_region This property is required. str
The signing region.
roleArn This property is required. String
The ARN of the signing role.
serviceName This property is required. String
The service name to use while signing with Sig V4.
signingRegion This property is required. String
The signing region.

TopicRuleSnsAction
, TopicRuleSnsActionArgs

RoleArn This property is required. string
The ARN of the IAM role that grants access.
TargetArn This property is required. string
The ARN of the SNS topic.
MessageFormat 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 .
RoleArn This property is required. string
The ARN of the IAM role that grants access.
TargetArn This property is required. string
The ARN of the SNS topic.
MessageFormat 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 .
roleArn This property is required. String
The ARN of the IAM role that grants access.
targetArn This property is required. String
The ARN of the SNS topic.
messageFormat 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 .
roleArn This property is required. string
The ARN of the IAM role that grants access.
targetArn This property is required. string
The ARN of the SNS topic.
messageFormat 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 This property is required. str
The ARN of the IAM role that grants access.
target_arn This property is required. 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 .
roleArn This property is required. String
The ARN of the IAM role that grants access.
targetArn This property is required. String
The ARN of the SNS topic.
messageFormat 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
, TopicRuleSqsActionArgs

QueueUrl This property is required. string
The URL of the Amazon SQS queue.
RoleArn This property is required. string
The ARN of the IAM role that grants access.
UseBase64 bool
Specifies whether to use Base64 encoding.
QueueUrl This property is required. string
The URL of the Amazon SQS queue.
RoleArn This property is required. string
The ARN of the IAM role that grants access.
UseBase64 bool
Specifies whether to use Base64 encoding.
queueUrl This property is required. String
The URL of the Amazon SQS queue.
roleArn This property is required. String
The ARN of the IAM role that grants access.
useBase64 Boolean
Specifies whether to use Base64 encoding.
queueUrl This property is required. string
The URL of the Amazon SQS queue.
roleArn This property is required. string
The ARN of the IAM role that grants access.
useBase64 boolean
Specifies whether to use Base64 encoding.
queue_url This property is required. str
The URL of the Amazon SQS queue.
role_arn This property is required. str
The ARN of the IAM role that grants access.
use_base64 bool
Specifies whether to use Base64 encoding.
queueUrl This property is required. String
The URL of the Amazon SQS queue.
roleArn This property is required. String
The ARN of the IAM role that grants access.
useBase64 Boolean
Specifies whether to use Base64 encoding.

TopicRuleStepFunctionsAction
, TopicRuleStepFunctionsActionArgs

RoleArn This property is required. string
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
StateMachineName This property is required. string
The name of the Step Functions state machine whose execution will be started.
ExecutionNamePrefix string
(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.
RoleArn This property is required. string
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
StateMachineName This property is required. string
The name of the Step Functions state machine whose execution will be started.
ExecutionNamePrefix string
(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.
roleArn This property is required. String
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineName This property is required. String
The name of the Step Functions state machine whose execution will be started.
executionNamePrefix String
(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.
roleArn This property is required. string
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineName This property is required. string
The name of the Step Functions state machine whose execution will be started.
executionNamePrefix string
(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 This property is required. str
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
state_machine_name This property is required. str
The name of the Step Functions state machine whose execution will be started.
execution_name_prefix str
(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.
roleArn This property is required. String
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineName This property is required. String
The name of the Step Functions state machine whose execution will be started.
executionNamePrefix String
(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
, TopicRuleTimestampArgs

Value This property is required. string
An expression that returns a long epoch time value.
Unit string
The precision of the timestamp value that results from the expression described in value .
Value This property is required. string
An expression that returns a long epoch time value.
Unit string
The precision of the timestamp value that results from the expression described in value .
value This property is required. String
An expression that returns a long epoch time value.
unit String
The precision of the timestamp value that results from the expression described in value .
value This property is required. string
An expression that returns a long epoch time value.
unit string
The precision of the timestamp value that results from the expression described in value .
value This property is required. str
An expression that returns a long epoch time value.
unit str
The precision of the timestamp value that results from the expression described in value .
value This property is required. String
An expression that returns a long epoch time value.
unit String
The precision of the timestamp value that results from the expression described in value .

TopicRuleTimestreamAction
, TopicRuleTimestreamActionArgs

DatabaseName This property is required. string
The name of an Amazon Timestream database that has the table to write records into.
Dimensions This property is required. List<Pulumi.AwsNative.IoT.Inputs.TopicRuleTimestreamDimension>
Metadata attributes of the time series that are written in each measure record.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
TableName This property is required. string
The table where the message data will be written.
Timestamp Pulumi.AwsNative.IoT.Inputs.TopicRuleTimestreamTimestamp
The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
DatabaseName This property is required. string
The name of an Amazon Timestream database that has the table to write records into.
Dimensions This property is required. []TopicRuleTimestreamDimension
Metadata attributes of the time series that are written in each measure record.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
TableName This property is required. string
The table where the message data will be written.
Timestamp TopicRuleTimestreamTimestamp
The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
databaseName This property is required. String
The name of an Amazon Timestream database that has the table to write records into.
dimensions This property is required. List<TopicRuleTimestreamDimension>
Metadata attributes of the time series that are written in each measure record.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
tableName This property is required. String
The table where the message data will be written.
timestamp TopicRuleTimestreamTimestamp
The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
databaseName This property is required. string
The name of an Amazon Timestream database that has the table to write records into.
dimensions This property is required. TopicRuleTimestreamDimension[]
Metadata attributes of the time series that are written in each measure record.
roleArn This property is required. string
The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
tableName This property is required. string
The table where the message data will be written.
timestamp TopicRuleTimestreamTimestamp
The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
database_name This property is required. str
The name of an Amazon Timestream database that has the table to write records into.
dimensions This property is required. Sequence[TopicRuleTimestreamDimension]
Metadata attributes of the time series that are written in each measure record.
role_arn This property is required. str
The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
table_name This property is required. str
The table where the message data will be written.
timestamp TopicRuleTimestreamTimestamp
The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
databaseName This property is required. String
The name of an Amazon Timestream database that has the table to write records into.
dimensions This property is required. List<Property Map>
Metadata attributes of the time series that are written in each measure record.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
tableName This property is required. 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
, TopicRuleTimestreamDimensionArgs

Name This property is required. string
Value This property is required. string
Name This property is required. string
Value This property is required. string
name This property is required. String
value This property is required. String
name This property is required. string
value This property is required. string
name This property is required. str
value This property is required. str
name This property is required. String
value This property is required. String

TopicRuleTimestreamTimestamp
, TopicRuleTimestreamTimestampArgs

Unit This property is required. string
The precision of the timestamp value that results from the expression described in value .
Value This property is required. string
An expression that returns a long epoch time value.
Unit This property is required. string
The precision of the timestamp value that results from the expression described in value .
Value This property is required. string
An expression that returns a long epoch time value.
unit This property is required. String
The precision of the timestamp value that results from the expression described in value .
value This property is required. String
An expression that returns a long epoch time value.
unit This property is required. string
The precision of the timestamp value that results from the expression described in value .
value This property is required. string
An expression that returns a long epoch time value.
unit This property is required. str
The precision of the timestamp value that results from the expression described in value .
value This property is required. str
An expression that returns a long epoch time value.
unit This property is required. String
The precision of the timestamp value that results from the expression described in value .
value This property is required. String
An expression that returns a long epoch time value.

TopicRuleUserProperty
, TopicRuleUserPropertyArgs

Key This property is required. string
Value This property is required. string
Key This property is required. string
Value This property is required. string
key This property is required. String
value This property is required. String
key This property is required. string
value This property is required. string
key This property is required. str
value This property is required. str
key This property is required. String
value This property is required. String

Package Details

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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi