---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_iot_topic_rule Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::IoT::TopicRule
---
# awscc_iot_topic_rule (Data Source)
Data Source schema for AWS::IoT::TopicRule
## Schema
### Required
- `id` (String) Uniquely identifies the resource.
### Read-Only
- `arn` (String)
- `rule_name` (String)
- `tags` (Attributes List) (see [below for nested schema](#nestedatt--tags))
- `topic_rule_payload` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload))
### Nested Schema for `tags`
Read-Only:
- `key` (String)
- `value` (String)
### Nested Schema for `topic_rule_payload`
Read-Only:
- `actions` (Attributes List) (see [below for nested schema](#nestedatt--topic_rule_payload--actions))
- `aws_iot_sql_version` (String)
- `description` (String)
- `error_action` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action))
- `rule_disabled` (Boolean)
- `sql` (String)
### Nested Schema for `topic_rule_payload.actions`
Read-Only:
- `cloudwatch_alarm` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--cloudwatch_alarm))
- `cloudwatch_logs` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--cloudwatch_logs))
- `cloudwatch_metric` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--cloudwatch_metric))
- `dynamo_d_bv_2` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--dynamo_d_bv_2))
- `dynamo_db` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--dynamo_db))
- `elasticsearch` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--elasticsearch))
- `firehose` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--firehose))
- `http` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--http))
- `iot_analytics` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--iot_analytics))
- `iot_events` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--iot_events))
- `iot_site_wise` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--iot_site_wise))
- `kafka` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--kafka))
- `kinesis` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--kinesis))
- `lambda` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--lambda))
- `open_search` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--open_search))
- `republish` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--republish))
- `s3` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--s3))
- `sns` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--sns))
- `sqs` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--sqs))
- `step_functions` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--step_functions))
- `timestream` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--timestream))
### Nested Schema for `topic_rule_payload.actions.cloudwatch_alarm`
Read-Only:
- `alarm_name` (String)
- `role_arn` (String)
- `state_reason` (String)
- `state_value` (String)
### Nested Schema for `topic_rule_payload.actions.cloudwatch_logs`
Read-Only:
- `log_group_name` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.actions.cloudwatch_metric`
Read-Only:
- `metric_name` (String)
- `metric_namespace` (String)
- `metric_timestamp` (String)
- `metric_unit` (String)
- `metric_value` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.actions.dynamo_d_bv_2`
Read-Only:
- `put_item` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--dynamo_d_bv_2--put_item))
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.actions.dynamo_d_bv_2.role_arn`
Read-Only:
- `table_name` (String)
### Nested Schema for `topic_rule_payload.actions.dynamo_db`
Read-Only:
- `hash_key_field` (String)
- `hash_key_type` (String)
- `hash_key_value` (String)
- `payload_field` (String)
- `range_key_field` (String)
- `range_key_type` (String)
- `range_key_value` (String)
- `role_arn` (String)
- `table_name` (String)
### Nested Schema for `topic_rule_payload.actions.elasticsearch`
Read-Only:
- `endpoint` (String)
- `id` (String) The ID of this resource.
- `index` (String)
- `role_arn` (String)
- `type` (String)
### Nested Schema for `topic_rule_payload.actions.firehose`
Read-Only:
- `batch_mode` (Boolean)
- `delivery_stream_name` (String)
- `role_arn` (String)
- `separator` (String)
### Nested Schema for `topic_rule_payload.actions.http`
Read-Only:
- `auth` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--http--auth))
- `confirmation_url` (String)
- `headers` (Attributes List) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--http--headers))
- `url` (String)
### Nested Schema for `topic_rule_payload.actions.http.url`
Read-Only:
- `sigv_4` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--http--url--sigv_4))
### Nested Schema for `topic_rule_payload.actions.http.url.sigv_4`
Read-Only:
- `role_arn` (String)
- `service_name` (String)
- `signing_region` (String)
### Nested Schema for `topic_rule_payload.actions.http.url`
Read-Only:
- `key` (String)
- `value` (String)
### Nested Schema for `topic_rule_payload.actions.iot_analytics`
Read-Only:
- `batch_mode` (Boolean)
- `channel_name` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.actions.iot_events`
Read-Only:
- `batch_mode` (Boolean)
- `input_name` (String)
- `message_id` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.actions.iot_site_wise`
Read-Only:
- `put_asset_property_value_entries` (Attributes List) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--iot_site_wise--put_asset_property_value_entries))
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.actions.iot_site_wise.role_arn`
Read-Only:
- `asset_id` (String)
- `entry_id` (String)
- `property_alias` (String)
- `property_id` (String)
- `property_values` (Attributes List) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--iot_site_wise--role_arn--property_values))
### Nested Schema for `topic_rule_payload.actions.iot_site_wise.role_arn.property_values`
Read-Only:
- `quality` (String)
- `timestamp` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--iot_site_wise--role_arn--property_values--timestamp))
- `value` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--iot_site_wise--role_arn--property_values--value))
### Nested Schema for `topic_rule_payload.actions.iot_site_wise.role_arn.property_values.value`
Read-Only:
- `offset_in_nanos` (String)
- `time_in_seconds` (String)
### Nested Schema for `topic_rule_payload.actions.iot_site_wise.role_arn.property_values.value`
Read-Only:
- `boolean_value` (String)
- `double_value` (String)
- `integer_value` (String)
- `string_value` (String)
### Nested Schema for `topic_rule_payload.actions.kafka`
Read-Only:
- `client_properties` (Map of String)
- `destination_arn` (String)
- `key` (String)
- `partition` (String)
- `topic` (String)
### Nested Schema for `topic_rule_payload.actions.kinesis`
Read-Only:
- `partition_key` (String)
- `role_arn` (String)
- `stream_name` (String)
### Nested Schema for `topic_rule_payload.actions.lambda`
Read-Only:
- `function_arn` (String)
### Nested Schema for `topic_rule_payload.actions.open_search`
Read-Only:
- `endpoint` (String)
- `id` (String) The ID of this resource.
- `index` (String)
- `role_arn` (String)
- `type` (String)
### Nested Schema for `topic_rule_payload.actions.republish`
Read-Only:
- `qos` (Number)
- `role_arn` (String)
- `topic` (String)
### Nested Schema for `topic_rule_payload.actions.s3`
Read-Only:
- `bucket_name` (String)
- `canned_acl` (String)
- `key` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.actions.sns`
Read-Only:
- `message_format` (String)
- `role_arn` (String)
- `target_arn` (String)
### Nested Schema for `topic_rule_payload.actions.sqs`
Read-Only:
- `queue_url` (String)
- `role_arn` (String)
- `use_base_64` (Boolean)
### Nested Schema for `topic_rule_payload.actions.step_functions`
Read-Only:
- `execution_name_prefix` (String)
- `role_arn` (String)
- `state_machine_name` (String)
### Nested Schema for `topic_rule_payload.actions.timestream`
Read-Only:
- `batch_mode` (Boolean)
- `database_name` (String)
- `dimensions` (Attributes List) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--timestream--dimensions))
- `role_arn` (String)
- `table_name` (String)
- `timestamp` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--actions--timestream--timestamp))
### Nested Schema for `topic_rule_payload.actions.timestream.timestamp`
Read-Only:
- `name` (String)
- `value` (String)
### Nested Schema for `topic_rule_payload.actions.timestream.timestamp`
Read-Only:
- `unit` (String)
- `value` (String)
### Nested Schema for `topic_rule_payload.error_action`
Read-Only:
- `cloudwatch_alarm` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--cloudwatch_alarm))
- `cloudwatch_logs` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--cloudwatch_logs))
- `cloudwatch_metric` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--cloudwatch_metric))
- `dynamo_d_bv_2` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--dynamo_d_bv_2))
- `dynamo_db` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--dynamo_db))
- `elasticsearch` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--elasticsearch))
- `firehose` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--firehose))
- `http` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--http))
- `iot_analytics` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--iot_analytics))
- `iot_events` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--iot_events))
- `iot_site_wise` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--iot_site_wise))
- `kafka` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--kafka))
- `kinesis` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--kinesis))
- `lambda` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--lambda))
- `open_search` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--open_search))
- `republish` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--republish))
- `s3` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--s3))
- `sns` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--sns))
- `sqs` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--sqs))
- `step_functions` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--step_functions))
- `timestream` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--timestream))
### Nested Schema for `topic_rule_payload.error_action.cloudwatch_alarm`
Read-Only:
- `alarm_name` (String)
- `role_arn` (String)
- `state_reason` (String)
- `state_value` (String)
### Nested Schema for `topic_rule_payload.error_action.cloudwatch_logs`
Read-Only:
- `log_group_name` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.error_action.cloudwatch_metric`
Read-Only:
- `metric_name` (String)
- `metric_namespace` (String)
- `metric_timestamp` (String)
- `metric_unit` (String)
- `metric_value` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.error_action.dynamo_d_bv_2`
Read-Only:
- `put_item` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--dynamo_d_bv_2--put_item))
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.error_action.dynamo_d_bv_2.role_arn`
Read-Only:
- `table_name` (String)
### Nested Schema for `topic_rule_payload.error_action.dynamo_db`
Read-Only:
- `hash_key_field` (String)
- `hash_key_type` (String)
- `hash_key_value` (String)
- `payload_field` (String)
- `range_key_field` (String)
- `range_key_type` (String)
- `range_key_value` (String)
- `role_arn` (String)
- `table_name` (String)
### Nested Schema for `topic_rule_payload.error_action.elasticsearch`
Read-Only:
- `endpoint` (String)
- `id` (String) The ID of this resource.
- `index` (String)
- `role_arn` (String)
- `type` (String)
### Nested Schema for `topic_rule_payload.error_action.firehose`
Read-Only:
- `batch_mode` (Boolean)
- `delivery_stream_name` (String)
- `role_arn` (String)
- `separator` (String)
### Nested Schema for `topic_rule_payload.error_action.http`
Read-Only:
- `auth` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--http--auth))
- `confirmation_url` (String)
- `headers` (Attributes List) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--http--headers))
- `url` (String)
### Nested Schema for `topic_rule_payload.error_action.http.url`
Read-Only:
- `sigv_4` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--http--url--sigv_4))
### Nested Schema for `topic_rule_payload.error_action.http.url.sigv_4`
Read-Only:
- `role_arn` (String)
- `service_name` (String)
- `signing_region` (String)
### Nested Schema for `topic_rule_payload.error_action.http.url`
Read-Only:
- `key` (String)
- `value` (String)
### Nested Schema for `topic_rule_payload.error_action.iot_analytics`
Read-Only:
- `batch_mode` (Boolean)
- `channel_name` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.error_action.iot_events`
Read-Only:
- `batch_mode` (Boolean)
- `input_name` (String)
- `message_id` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.error_action.iot_site_wise`
Read-Only:
- `put_asset_property_value_entries` (Attributes List) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--iot_site_wise--put_asset_property_value_entries))
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.error_action.iot_site_wise.role_arn`
Read-Only:
- `asset_id` (String)
- `entry_id` (String)
- `property_alias` (String)
- `property_id` (String)
- `property_values` (Attributes List) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--iot_site_wise--role_arn--property_values))
### Nested Schema for `topic_rule_payload.error_action.iot_site_wise.role_arn.property_values`
Read-Only:
- `quality` (String)
- `timestamp` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--iot_site_wise--role_arn--property_values--timestamp))
- `value` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--iot_site_wise--role_arn--property_values--value))
### Nested Schema for `topic_rule_payload.error_action.iot_site_wise.role_arn.property_values.value`
Read-Only:
- `offset_in_nanos` (String)
- `time_in_seconds` (String)
### Nested Schema for `topic_rule_payload.error_action.iot_site_wise.role_arn.property_values.value`
Read-Only:
- `boolean_value` (String)
- `double_value` (String)
- `integer_value` (String)
- `string_value` (String)
### Nested Schema for `topic_rule_payload.error_action.kafka`
Read-Only:
- `client_properties` (Map of String)
- `destination_arn` (String)
- `key` (String)
- `partition` (String)
- `topic` (String)
### Nested Schema for `topic_rule_payload.error_action.kinesis`
Read-Only:
- `partition_key` (String)
- `role_arn` (String)
- `stream_name` (String)
### Nested Schema for `topic_rule_payload.error_action.lambda`
Read-Only:
- `function_arn` (String)
### Nested Schema for `topic_rule_payload.error_action.open_search`
Read-Only:
- `endpoint` (String)
- `id` (String) The ID of this resource.
- `index` (String)
- `role_arn` (String)
- `type` (String)
### Nested Schema for `topic_rule_payload.error_action.republish`
Read-Only:
- `qos` (Number)
- `role_arn` (String)
- `topic` (String)
### Nested Schema for `topic_rule_payload.error_action.s3`
Read-Only:
- `bucket_name` (String)
- `canned_acl` (String)
- `key` (String)
- `role_arn` (String)
### Nested Schema for `topic_rule_payload.error_action.sns`
Read-Only:
- `message_format` (String)
- `role_arn` (String)
- `target_arn` (String)
### Nested Schema for `topic_rule_payload.error_action.sqs`
Read-Only:
- `queue_url` (String)
- `role_arn` (String)
- `use_base_64` (Boolean)
### Nested Schema for `topic_rule_payload.error_action.step_functions`
Read-Only:
- `execution_name_prefix` (String)
- `role_arn` (String)
- `state_machine_name` (String)
### Nested Schema for `topic_rule_payload.error_action.timestream`
Read-Only:
- `batch_mode` (Boolean)
- `database_name` (String)
- `dimensions` (Attributes List) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--timestream--dimensions))
- `role_arn` (String)
- `table_name` (String)
- `timestamp` (Attributes) (see [below for nested schema](#nestedatt--topic_rule_payload--error_action--timestream--timestamp))
### Nested Schema for `topic_rule_payload.error_action.timestream.timestamp`
Read-Only:
- `name` (String)
- `value` (String)
### Nested Schema for `topic_rule_payload.error_action.timestream.timestamp`
Read-Only:
- `unit` (String)
- `value` (String)