AWS Cloud Control v1.9.0, Nov 18 24

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iot.getTopicRule

Explore with Pulumi AI

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

Using getTopicRule

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

function getTopicRule(args: GetTopicRuleArgs, opts?: InvokeOptions): Promise<GetTopicRuleResult>
function getTopicRuleOutput(args: GetTopicRuleOutputArgs, opts?: InvokeOptions): Output<GetTopicRuleResult>

def get_topic_rule(rule_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetTopicRuleResult
def get_topic_rule_output(rule_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetTopicRuleResult]

func LookupTopicRule(ctx *Context, args *LookupTopicRuleArgs, opts ...InvokeOption) (*LookupTopicRuleResult, error)
func LookupTopicRuleOutput(ctx *Context, args *LookupTopicRuleOutputArgs, opts ...InvokeOption) LookupTopicRuleResultOutput

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

public static class GetTopicRule 
{
    public static Task<GetTopicRuleResult> InvokeAsync(GetTopicRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetTopicRuleResult> Invoke(GetTopicRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTopicRuleResult> getTopicRule(GetTopicRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:iot:getTopicRule
  arguments:
    # arguments dictionary

The following arguments are supported:

RuleName string

The name of the rule.

Pattern : ^[a-zA-Z0-9_]+$

RuleName string

The name of the rule.

Pattern : ^[a-zA-Z0-9_]+$

ruleName String

The name of the rule.

Pattern : ^[a-zA-Z0-9_]+$

ruleName string

The name of the rule.

Pattern : ^[a-zA-Z0-9_]+$

rule_name str

The name of the rule.

Pattern : ^[a-zA-Z0-9_]+$

ruleName String

The name of the rule.

Pattern : ^[a-zA-Z0-9_]+$

getTopicRule Result

The following output properties are available:

Arn string: The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
Tags List<Pulumi.AwsNative.Outputs.Tag>: Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
TopicRulePayload Pulumi.AwsNative.IoT.Outputs.TopicRulePayload: The rule payload.

Arn string: The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
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..."
TopicRulePayload TopicRulePayload: The rule payload.

arn String: The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
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 TopicRulePayload: The rule payload.

arn string: The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
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..."
topicRulePayload TopicRulePayload: The rule payload.

arn str: The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
tags Sequence[root_Tag]: Metadata which can be used to manage the topic rule.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
topic_rule_payload TopicRulePayload: The rule payload.

arn String: The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
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..."
topicRulePayload Property Map: The rule payload.

Supporting Types

TopicRuleAction

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

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

Timestamp Pulumi.AwsNative.IoT.Inputs.TopicRuleAssetPropertyTimestamp: The asset property value timestamp.
Value 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 TopicRuleAssetPropertyTimestamp: The asset property value timestamp.
Value 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 TopicRuleAssetPropertyTimestamp: The asset property value timestamp.
value 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 TopicRuleAssetPropertyTimestamp: The asset property value timestamp.
value 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 TopicRuleAssetPropertyTimestamp: The asset property value timestamp.
value 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 Property Map: The asset property value timestamp.
value Property Map: The value of the asset property.
quality String: Optional. A string that describes the quality of the value. Accepts substitution templates. Must be GOOD , BAD , or UNCERTAIN .

TopicRuleAssetPropertyVariant

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

TopicRuleCloudwatchAlarmAction

AlarmName string: The CloudWatch alarm name.
RoleArn string: The IAM role that allows access to the CloudWatch alarm.
StateReason string: The reason for the alarm change.
StateValue string: The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

AlarmName string: The CloudWatch alarm name.
RoleArn string: The IAM role that allows access to the CloudWatch alarm.
StateReason string: The reason for the alarm change.
StateValue string: The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

alarmName String: The CloudWatch alarm name.
roleArn String: The IAM role that allows access to the CloudWatch alarm.
stateReason String: The reason for the alarm change.
stateValue String: The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

alarmName string: The CloudWatch alarm name.
roleArn string: The IAM role that allows access to the CloudWatch alarm.
stateReason string: The reason for the alarm change.
stateValue string: The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

alarm_name str: The CloudWatch alarm name.
role_arn str: The IAM role that allows access to the CloudWatch alarm.
state_reason str: The reason for the alarm change.
state_value str: The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

alarmName String: The CloudWatch alarm name.
roleArn String: The IAM role that allows access to the CloudWatch alarm.
stateReason String: The reason for the alarm change.
stateValue String: The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

TopicRuleCloudwatchLogsAction

LogGroupName string: The CloudWatch log name.
RoleArn 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 string: The CloudWatch log name.
RoleArn 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 String: The CloudWatch log name.
roleArn 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 string: The CloudWatch log name.
roleArn 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 str: The CloudWatch log name.
role_arn str: The IAM role that allows access to the CloudWatch log.
batch_mode bool: Indicates whether batches of log records will be extracted and uploaded into CloudWatch.

logGroupName String: The CloudWatch log name.
roleArn 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

MetricName string: The CloudWatch metric name.
MetricNamespace string: The CloudWatch metric namespace name.
MetricUnit string: The metric unit supported by CloudWatch.
MetricValue string: The CloudWatch metric value.
RoleArn string: The IAM role that allows access to the CloudWatch metric.
MetricTimestamp string: An optional Unix timestamp .

MetricName string: The CloudWatch metric name.
MetricNamespace string: The CloudWatch metric namespace name.
MetricUnit string: The metric unit supported by CloudWatch.
MetricValue string: The CloudWatch metric value.
RoleArn string: The IAM role that allows access to the CloudWatch metric.
MetricTimestamp string: An optional Unix timestamp .

metricName String: The CloudWatch metric name.
metricNamespace String: The CloudWatch metric namespace name.
metricUnit String: The metric unit supported by CloudWatch.
metricValue String: The CloudWatch metric value.
roleArn String: The IAM role that allows access to the CloudWatch metric.
metricTimestamp String: An optional Unix timestamp .

metricName string: The CloudWatch metric name.
metricNamespace string: The CloudWatch metric namespace name.
metricUnit string: The metric unit supported by CloudWatch.
metricValue string: The CloudWatch metric value.
roleArn string: The IAM role that allows access to the CloudWatch metric.
metricTimestamp string: An optional Unix timestamp .

metric_name str: The CloudWatch metric name.
metric_namespace str: The CloudWatch metric namespace name.
metric_unit str: The metric unit supported by CloudWatch.
metric_value str: The CloudWatch metric value.
role_arn str: The IAM role that allows access to the CloudWatch metric.
metric_timestamp str: An optional Unix timestamp .

metricName String: The CloudWatch metric name.
metricNamespace String: The CloudWatch metric namespace name.
metricUnit String: The metric unit supported by CloudWatch.
metricValue String: The CloudWatch metric value.
roleArn String: The IAM role that allows access to the CloudWatch metric.
metricTimestamp String: An optional Unix timestamp .

TopicRuleDynamoDBv2Action

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

HashKeyField string: The hash key name.
HashKeyValue string: The hash key value.
RoleArn string: The ARN of the IAM role that grants access to the DynamoDB table.
TableName 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 string: The hash key name.
HashKeyValue string: The hash key value.
RoleArn string: The ARN of the IAM role that grants access to the DynamoDB table.
TableName 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 String: The hash key name.
hashKeyValue String: The hash key value.
roleArn String: The ARN of the IAM role that grants access to the DynamoDB table.
tableName 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 string: The hash key name.
hashKeyValue string: The hash key value.
roleArn string: The ARN of the IAM role that grants access to the DynamoDB table.
tableName 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 str: The hash key name.
hash_key_value str: The hash key value.
role_arn str: The ARN of the IAM role that grants access to the DynamoDB table.
table_name str: The name of the DynamoDB table.
hash_key_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 String: The hash key name.
hashKeyValue String: The hash key value.
roleArn String: The ARN of the IAM role that grants access to the DynamoDB table.
tableName 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

Endpoint string: The endpoint of your OpenSearch domain.
Id string: The unique identifier for the document you are storing.
Index string: The index where you want to store your data.
RoleArn string: The IAM role ARN that has access to OpenSearch.
Type string: The type of document you are storing.

Endpoint string: The endpoint of your OpenSearch domain.
Id string: The unique identifier for the document you are storing.
Index string: The index where you want to store your data.
RoleArn string: The IAM role ARN that has access to OpenSearch.
Type string: The type of document you are storing.

endpoint String: The endpoint of your OpenSearch domain.
id String: The unique identifier for the document you are storing.
index String: The index where you want to store your data.
roleArn String: The IAM role ARN that has access to OpenSearch.
type String: The type of document you are storing.

endpoint string: The endpoint of your OpenSearch domain.
id string: The unique identifier for the document you are storing.
index string: The index where you want to store your data.
roleArn string: The IAM role ARN that has access to OpenSearch.
type string: The type of document you are storing.

endpoint str: The endpoint of your OpenSearch domain.
id str: The unique identifier for the document you are storing.
index str: The index where you want to store your data.
role_arn str: The IAM role ARN that has access to OpenSearch.
type str: The type of document you are storing.

endpoint String: The endpoint of your OpenSearch domain.
id String: The unique identifier for the document you are storing.
index String: The index where you want to store your data.
roleArn String: The IAM role ARN that has access to OpenSearch.
type String: The type of document you are storing.

TopicRuleFirehoseAction

DeliveryStreamName string

The delivery stream name.

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

The delivery stream name.

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

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 String

The delivery stream name.

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

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 string

The delivery stream name.

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

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 str

The delivery stream name.

role_arn str

The IAM role that grants access to the Amazon Kinesis Firehose stream.

batch_mode bool

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

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 String

The delivery stream name.

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

separator String

A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).

TopicRuleHttpAction

Url string: The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl . If this is a new destination, a 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 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 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 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 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 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

Key string: The HTTP header key.
Value string: The HTTP header value. Substitution templates are supported.

Key string: The HTTP header key.
Value string: The HTTP header value. Substitution templates are supported.

key String: The HTTP header key.
value String: The HTTP header value. Substitution templates are supported.

key string: The HTTP header key.
value string: The HTTP header value. Substitution templates are supported.

key str: The HTTP header key.
value str: The HTTP header value. Substitution templates are supported.

key String: The HTTP header key.
value String: The HTTP header value. Substitution templates are supported.

TopicRuleHttpAuthorization

Sigv4 Pulumi.AwsNative.IoT.Inputs.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 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

ChannelName string

The name of the IoT Analytics channel to which message data will be sent.

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

The name of the IoT Analytics channel to which message data will be sent.

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

channelName String

The name of the IoT Analytics channel to which message data will be sent.

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

channelName string

The name of the IoT Analytics channel to which message data will be sent.

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

channel_name str

The name of the IoT Analytics channel to which message data will be sent.

role_arn str

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

batch_mode bool

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

channelName String

The name of the IoT Analytics channel to which message data will be sent.

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

TopicRuleIotEventsAction

InputName string

The name of the AWS IoT Events input.

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

The name of the AWS IoT Events input.

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

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 String

The name of the AWS IoT Events input.

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

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 string

The name of the AWS IoT Events input.

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

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 str

The name of the AWS IoT Events input.

role_arn str

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").

batch_mode bool

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

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

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 String

The name of the AWS IoT Events input.

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

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

PutAssetPropertyValueEntries List<Pulumi.AwsNative.IoT.Inputs.TopicRulePutAssetPropertyValueEntry>: A list of asset property value entries.
RoleArn 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 []TopicRulePutAssetPropertyValueEntry: A list of asset property value entries.
RoleArn 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 List<TopicRulePutAssetPropertyValueEntry>: A list of asset property value entries.
roleArn 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 TopicRulePutAssetPropertyValueEntry[]: A list of asset property value entries.
roleArn 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 Sequence[TopicRulePutAssetPropertyValueEntry]: A list of asset property value entries.
role_arn str: The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. ( "Action": "iotsitewise:BatchPutAssetPropertyValue" ). The trust policy can restrict access to specific asset hierarchy paths.

putAssetPropertyValueEntries List<Property Map>: A list of asset property value entries.
roleArn 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

ClientProperties Dictionary<string, string>: Properties of the Apache Kafka producer client.
DestinationArn string: The ARN of Kafka action's VPC TopicRuleDestination .
Topic string: The Kafka topic for messages to be sent to the Kafka broker.
Headers List<Pulumi.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 map[string]string: Properties of the Apache Kafka producer client.
DestinationArn string: The ARN of Kafka action's VPC TopicRuleDestination .
Topic 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 Map<String,String>: Properties of the Apache Kafka producer client.
destinationArn String: The ARN of Kafka action's VPC TopicRuleDestination .
topic String: The Kafka topic for messages to be sent to the Kafka broker.
headers List<TopicRuleKafkaActionHeader>: The list of Kafka headers that you specify.
key String: The Kafka message key.
partition String: The Kafka message partition.

clientProperties {[key: string]: string}: Properties of the Apache Kafka producer client.
destinationArn string: The ARN of Kafka action's VPC TopicRuleDestination .
topic 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 Mapping[str, str]: Properties of the Apache Kafka producer client.
destination_arn str: The ARN of Kafka action's VPC TopicRuleDestination .
topic str: The Kafka topic for messages to be sent to the Kafka broker.
headers Sequence[TopicRuleKafkaActionHeader]: The list of Kafka headers that you specify.
key str: The Kafka message key.
partition str: The Kafka message partition.

clientProperties Map<String>: Properties of the Apache Kafka producer client.
destinationArn String: The ARN of Kafka action's VPC TopicRuleDestination .
topic String: The Kafka topic for messages to be sent to the Kafka broker.
headers List<Property Map>: The list of Kafka headers that you specify.
key String: The Kafka message key.
partition String: The Kafka message partition.

TopicRuleKafkaActionHeader

Key string: The key of the Kafka header.
Value string: The value of the Kafka header.

Key string: The key of the Kafka header.
Value string: The value of the Kafka header.

key String: The key of the Kafka header.
value String: The value of the Kafka header.

key string: The key of the Kafka header.
value string: The value of the Kafka header.

key str: The key of the Kafka header.
value str: The value of the Kafka header.

key String: The key of the Kafka header.
value String: The value of the Kafka header.

TopicRuleKinesisAction

RoleArn string: The ARN of the IAM role that grants access to the Amazon Kinesis stream.
StreamName string: The name of the Amazon Kinesis stream.
PartitionKey string: The partition key.

RoleArn string: The ARN of the IAM role that grants access to the Amazon Kinesis stream.
StreamName string: The name of the Amazon Kinesis stream.
PartitionKey string: The partition key.

roleArn String: The ARN of the IAM role that grants access to the Amazon Kinesis stream.
streamName String: The name of the Amazon Kinesis stream.
partitionKey String: The partition key.

roleArn string: The ARN of the IAM role that grants access to the Amazon Kinesis stream.
streamName string: The name of the Amazon Kinesis stream.
partitionKey string: The partition key.

role_arn str: The ARN of the IAM role that grants access to the Amazon Kinesis stream.
stream_name str: The name of the Amazon Kinesis stream.
partition_key str: The partition key.

roleArn String: The ARN of the IAM role that grants access to the Amazon Kinesis stream.
streamName String: The name of the Amazon Kinesis stream.
partitionKey String: The partition key.

TopicRuleLambdaAction

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

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

deviceId String: The unique ID of the device providing the location data.
latitude String: A string that evaluates to a double value that represents the latitude of the device's location.
longitude String: A string that evaluates to a double value that represents the longitude of the device's location.
roleArn String: The IAM role that grants permission to write to the Amazon Location resource.
trackerName 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

Endpoint string: The endpoint of your OpenSearch domain.
Id string: The unique identifier for the document you are storing.
Index string: The OpenSearch index where you want to store your data.
RoleArn string: The IAM role ARN that has access to OpenSearch.
Type string: The type of document you are storing.

Endpoint string: The endpoint of your OpenSearch domain.
Id string: The unique identifier for the document you are storing.
Index string: The OpenSearch index where you want to store your data.
RoleArn string: The IAM role ARN that has access to OpenSearch.
Type string: The type of document you are storing.

endpoint String: The endpoint of your OpenSearch domain.
id String: The unique identifier for the document you are storing.
index String: The OpenSearch index where you want to store your data.
roleArn String: The IAM role ARN that has access to OpenSearch.
type String: The type of document you are storing.

endpoint string: The endpoint of your OpenSearch domain.
id string: The unique identifier for the document you are storing.
index string: The OpenSearch index where you want to store your data.
roleArn string: The IAM role ARN that has access to OpenSearch.
type string: The type of document you are storing.

endpoint str: The endpoint of your OpenSearch domain.
id str: The unique identifier for the document you are storing.
index str: The OpenSearch index where you want to store your data.
role_arn str: The IAM role ARN that has access to OpenSearch.
type str: The type of document you are storing.

endpoint String: The endpoint of your OpenSearch domain.
id String: The unique identifier for the document you are storing.
index String: The OpenSearch index where you want to store your data.
roleArn String: The IAM role ARN that has access to OpenSearch.
type String: The type of document you are storing.

TopicRulePayload

Actions List<Pulumi.AwsNative.IoT.Inputs.TopicRuleAction>

The actions associated with the rule.

Sql string

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .

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 []TopicRuleAction

The actions associated with the rule.

Sql string

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .

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

The actions associated with the rule.

sql String

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .

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 TopicRuleAction[]

The actions associated with the rule.

sql string

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .

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 Sequence[TopicRuleAction]

The actions associated with the rule.

sql str

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .

aws_iot_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 List<Property Map>

The actions associated with the rule.

sql String

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .

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

PropertyValues 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 []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 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 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 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 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

TableName string: The table where the message data will be written.

TableName string: The table where the message data will be written.

tableName String: The table where the message data will be written.

tableName string: The table where the message data will be written.

table_name str: The table where the message data will be written.

tableName String: The table where the message data will be written.

TopicRuleRepublishAction

RoleArn string: The ARN of the IAM role that grants access.
Topic 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 string: The ARN of the IAM role that grants access.
Topic 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 String: The ARN of the IAM role that grants access.
topic 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 string: The ARN of the IAM role that grants access.
topic 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 str: The ARN of the IAM role that grants access.
topic 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 String: The ARN of the IAM role that grants access.
topic String: The name of the MQTT topic.
headers Property Map: MQTT Version 5.0 headers information. For more information, see MQTT in the IoT Core Developer Guide.
qos Number: The Quality of Service (QoS) level to use when republishing messages. The default value is 0.

TopicRuleRepublishActionHeaders

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

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

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

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

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

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

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

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

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

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

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

BucketName string: The Amazon S3 bucket.
Key string: The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
RoleArn 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 string: The Amazon S3 bucket.
Key string: The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
RoleArn 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 String: The Amazon S3 bucket.
key String: The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
roleArn 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 string: The Amazon S3 bucket.
key string: The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
roleArn 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 str: The Amazon S3 bucket.
key str: The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
role_arn str: The ARN of the IAM role that grants access.
canned_acl 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 String: The Amazon S3 bucket.
key String: The object key. For more information, see Actions, resources, and condition keys for Amazon S3 .
roleArn 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

RoleArn string: The ARN of the signing role.
ServiceName string: The service name to use while signing with Sig V4.
SigningRegion string: The signing region.

RoleArn string: The ARN of the signing role.
ServiceName string: The service name to use while signing with Sig V4.
SigningRegion string: The signing region.

roleArn String: The ARN of the signing role.
serviceName String: The service name to use while signing with Sig V4.
signingRegion String: The signing region.

roleArn string: The ARN of the signing role.
serviceName string: The service name to use while signing with Sig V4.
signingRegion string: The signing region.

role_arn str: The ARN of the signing role.
service_name str: The service name to use while signing with Sig V4.
signing_region str: The signing region.

roleArn String: The ARN of the signing role.
serviceName String: The service name to use while signing with Sig V4.
signingRegion String: The signing region.

TopicRuleSnsAction

RoleArn string: The ARN of the IAM role that grants access.
TargetArn 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 string: The ARN of the IAM role that grants access.
TargetArn 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 String: The ARN of the IAM role that grants access.
targetArn 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 string: The ARN of the IAM role that grants access.
targetArn 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 str: The ARN of the IAM role that grants access.
target_arn str: The ARN of the SNS topic.
message_format str: (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see Amazon SNS Message and JSON Formats in the Amazon Simple Notification Service Developer Guide .

roleArn String: The ARN of the IAM role that grants access.
targetArn 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

QueueUrl string: The URL of the Amazon SQS queue.
RoleArn string: The ARN of the IAM role that grants access.
UseBase64 bool: Specifies whether to use Base64 encoding.

QueueUrl string: The URL of the Amazon SQS queue.
RoleArn string: The ARN of the IAM role that grants access.
UseBase64 bool: Specifies whether to use Base64 encoding.

queueUrl String: The URL of the Amazon SQS queue.
roleArn String: The ARN of the IAM role that grants access.
useBase64 Boolean: Specifies whether to use Base64 encoding.

queueUrl string: The URL of the Amazon SQS queue.
roleArn string: The ARN of the IAM role that grants access.
useBase64 boolean: Specifies whether to use Base64 encoding.

queue_url str: The URL of the Amazon SQS queue.
role_arn str: The ARN of the IAM role that grants access.
use_base64 bool: Specifies whether to use Base64 encoding.

queueUrl String: The URL of the Amazon SQS queue.
roleArn String: The ARN of the IAM role that grants access.
useBase64 Boolean: Specifies whether to use Base64 encoding.

TopicRuleStepFunctionsAction

RoleArn string: The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
StateMachineName 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 string: The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
StateMachineName 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 String: The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineName 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 string: The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineName 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 str: The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
state_machine_name 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 String: The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
stateMachineName 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

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

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

databaseName String: The name of an Amazon Timestream database that has the table to write records into.
dimensions List<Property Map>: Metadata attributes of the time series that are written in each measure record.
roleArn String: The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
tableName 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

Name string
Value string

Name string
Value string

name String
value String

name string
value string

name str
value str

name String
value String

TopicRuleTimestreamTimestamp

Unit string: The precision of the timestamp value that results from the expression described in value .
Value 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 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 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 string: 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 str: 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 String: An expression that returns a long epoch time value.

TopicRuleUserProperty

Key string
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value 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.9.0 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.iot.getTopicRule

On this page

On this page

Using getTopicRule

getTopicRule Result

Supporting Types

Tag

TopicRuleAction

TopicRuleAssetPropertyTimestamp

TopicRuleAssetPropertyValue

TopicRuleAssetPropertyVariant

TopicRuleCannedAccessControlList

TopicRuleCloudwatchAlarmAction

TopicRuleCloudwatchLogsAction

TopicRuleCloudwatchMetricAction

TopicRuleDynamoDBv2Action

TopicRuleDynamoDbAction

TopicRuleElasticsearchAction

TopicRuleFirehoseAction

TopicRuleHttpAction

TopicRuleHttpActionHeader

TopicRuleHttpAuthorization

TopicRuleIotAnalyticsAction

TopicRuleIotEventsAction

TopicRuleIotSiteWiseAction

TopicRuleKafkaAction

TopicRuleKafkaActionHeader

TopicRuleKinesisAction

TopicRuleLambdaAction

TopicRuleLocationAction

TopicRuleOpenSearchAction

TopicRulePayload

TopicRulePutAssetPropertyValueEntry

TopicRulePutItemInput

TopicRuleRepublishAction

TopicRuleRepublishActionHeaders

TopicRuleS3Action

TopicRuleSigV4Authorization

TopicRuleSnsAction

TopicRuleSqsAction

TopicRuleStepFunctionsAction

TopicRuleTimestamp

TopicRuleTimestreamAction

TopicRuleTimestreamDimension

TopicRuleTimestreamTimestamp

TopicRuleUserProperty

Package Details

On this page

On this page