Resource Type definition for AWS::IoT::TopicRule
topic_rule_payload
(Attributes) (see below for nested schema)rule_name
(String)tags
(Attributes List) (see below for nested schema)arn
(String)id
(String) Uniquely identifies the resource.topic_rule_payload
Required:
actions
(Attributes List) (see below for nested schema)sql
(String)Optional:
aws_iot_sql_version
(String)description
(String)error_action
(Attributes) (see below for nested schema)rule_disabled
(Boolean)topic_rule_payload.actions
Optional:
cloudwatch_alarm
(Attributes) (see below for nested schema)cloudwatch_logs
(Attributes) (see below for nested schema)cloudwatch_metric
(Attributes) (see below for nested schema)dynamo_d_bv_2
(Attributes) (see below for nested schema)dynamo_db
(Attributes) (see below for nested schema)elasticsearch
(Attributes) (see below for nested schema)firehose
(Attributes) (see below for nested schema)http
(Attributes) (see below for nested schema)iot_analytics
(Attributes) (see below for nested schema)iot_events
(Attributes) (see below for nested schema)iot_site_wise
(Attributes) (see below for nested schema)kafka
(Attributes) (see below for nested schema)kinesis
(Attributes) (see below for nested schema)lambda
(Attributes) (see below for nested schema)location
(Attributes) (see below for nested schema)open_search
(Attributes) (see below for nested schema)republish
(Attributes) (see below for nested schema)s3
(Attributes) (see below for nested schema)sns
(Attributes) (see below for nested schema)sqs
(Attributes) (see below for nested schema)step_functions
(Attributes) (see below for nested schema)timestream
(Attributes) (see below for nested schema)topic_rule_payload.actions.cloudwatch_alarm
Required:
alarm_name
(String)role_arn
(String)state_reason
(String)state_value
(String)topic_rule_payload.actions.cloudwatch_logs
Required:
log_group_name
(String)role_arn
(String)Optional:
batch_mode
(Boolean)topic_rule_payload.actions.cloudwatch_metric
Required:
metric_name
(String)metric_namespace
(String)metric_unit
(String)metric_value
(String)role_arn
(String)Optional:
metric_timestamp
(String)topic_rule_payload.actions.dynamo_d_bv_2
Optional:
put_item
(Attributes) (see below for nested schema)role_arn
(String)topic_rule_payload.actions.dynamo_d_bv_2.put_item
Required:
table_name
(String)topic_rule_payload.actions.dynamo_db
Required:
hash_key_field
(String)hash_key_value
(String)role_arn
(String)table_name
(String)Optional:
hash_key_type
(String)payload_field
(String)range_key_field
(String)range_key_type
(String)range_key_value
(String)topic_rule_payload.actions.elasticsearch
Required:
endpoint
(String)id
(String)index
(String)role_arn
(String)type
(String)topic_rule_payload.actions.firehose
Required:
delivery_stream_name
(String)role_arn
(String)Optional:
batch_mode
(Boolean)separator
(String)topic_rule_payload.actions.http
Required:
url
(String)Optional:
auth
(Attributes) (see below for nested schema)confirmation_url
(String)headers
(Attributes List) (see below for nested schema)topic_rule_payload.actions.http.auth
Optional:
sigv_4
(Attributes) (see below for nested schema)topic_rule_payload.actions.http.headers.sigv_4
Required:
role_arn
(String)service_name
(String)signing_region
(String)topic_rule_payload.actions.http.headers
Required:
key
(String)value
(String)topic_rule_payload.actions.iot_analytics
Required:
channel_name
(String)role_arn
(String)Optional:
batch_mode
(Boolean)topic_rule_payload.actions.iot_events
Required:
input_name
(String)role_arn
(String)Optional:
batch_mode
(Boolean)message_id
(String)topic_rule_payload.actions.iot_site_wise
Required:
put_asset_property_value_entries
(Attributes List) (see below for nested schema)role_arn
(String)topic_rule_payload.actions.iot_site_wise.put_asset_property_value_entries
Required:
property_values
(Attributes List) (see below for nested schema)Optional:
asset_id
(String)entry_id
(String)property_alias
(String)property_id
(String)topic_rule_payload.actions.iot_site_wise.role_arn.property_values
Required:
timestamp
(Attributes) (see below for nested schema)value
(Attributes) (see below for nested schema)Optional:
quality
(String)topic_rule_payload.actions.iot_site_wise.role_arn.property_values.timestamp
Required:
time_in_seconds
(String)Optional:
offset_in_nanos
(String)topic_rule_payload.actions.iot_site_wise.role_arn.property_values.value
Optional:
boolean_value
(String)double_value
(String)integer_value
(String)string_value
(String)topic_rule_payload.actions.kafka
Required:
client_properties
(Map of String)destination_arn
(String)topic
(String)Optional:
headers
(Attributes List) (see below for nested schema)key
(String)partition
(String)topic_rule_payload.actions.kafka.headers
Required:
key
(String)value
(String)topic_rule_payload.actions.kinesis
Required:
role_arn
(String)stream_name
(String)Optional:
partition_key
(String)topic_rule_payload.actions.lambda
Optional:
function_arn
(String)topic_rule_payload.actions.location
Required:
device_id
(String)latitude
(String)longitude
(String)role_arn
(String)tracker_name
(String)Optional:
timestamp
(Attributes) (see below for nested schema)topic_rule_payload.actions.location.timestamp
Required:
value
(String)Optional:
unit
(String)topic_rule_payload.actions.open_search
Required:
endpoint
(String)id
(String)index
(String)role_arn
(String)type
(String)topic_rule_payload.actions.republish
Required:
role_arn
(String)topic
(String)Optional:
headers
(Attributes) (see below for nested schema)qos
(Number)topic_rule_payload.actions.republish.headers
Optional:
content_type
(String)correlation_data
(String)message_expiry
(String)payload_format_indicator
(String)response_topic
(String)user_properties
(Attributes List) (see below for nested schema)topic_rule_payload.actions.republish.qos.user_properties
Required:
key
(String)value
(String)topic_rule_payload.actions.s3
Required:
bucket_name
(String)key
(String)role_arn
(String)Optional:
canned_acl
(String)topic_rule_payload.actions.sns
Required:
role_arn
(String)target_arn
(String)Optional:
message_format
(String)topic_rule_payload.actions.sqs
Required:
queue_url
(String)role_arn
(String)Optional:
use_base_64
(Boolean)topic_rule_payload.actions.step_functions
Required:
role_arn
(String)state_machine_name
(String)Optional:
execution_name_prefix
(String)topic_rule_payload.actions.timestream
Required:
database_name
(String)dimensions
(Attributes List) (see below for nested schema)role_arn
(String)table_name
(String)Optional:
timestamp
(Attributes) (see below for nested schema)topic_rule_payload.actions.timestream.dimensions
Required:
name
(String)value
(String)topic_rule_payload.actions.timestream.timestamp
Required:
unit
(String)value
(String)topic_rule_payload.error_action
Optional:
cloudwatch_alarm
(Attributes) (see below for nested schema)cloudwatch_logs
(Attributes) (see below for nested schema)cloudwatch_metric
(Attributes) (see below for nested schema)dynamo_d_bv_2
(Attributes) (see below for nested schema)dynamo_db
(Attributes) (see below for nested schema)elasticsearch
(Attributes) (see below for nested schema)firehose
(Attributes) (see below for nested schema)http
(Attributes) (see below for nested schema)iot_analytics
(Attributes) (see below for nested schema)iot_events
(Attributes) (see below for nested schema)iot_site_wise
(Attributes) (see below for nested schema)kafka
(Attributes) (see below for nested schema)kinesis
(Attributes) (see below for nested schema)lambda
(Attributes) (see below for nested schema)location
(Attributes) (see below for nested schema)open_search
(Attributes) (see below for nested schema)republish
(Attributes) (see below for nested schema)s3
(Attributes) (see below for nested schema)sns
(Attributes) (see below for nested schema)sqs
(Attributes) (see below for nested schema)step_functions
(Attributes) (see below for nested schema)timestream
(Attributes) (see below for nested schema)topic_rule_payload.error_action.cloudwatch_alarm
Required:
alarm_name
(String)role_arn
(String)state_reason
(String)state_value
(String)topic_rule_payload.error_action.cloudwatch_logs
Required:
log_group_name
(String)role_arn
(String)Optional:
batch_mode
(Boolean)topic_rule_payload.error_action.cloudwatch_metric
Required:
metric_name
(String)metric_namespace
(String)metric_unit
(String)metric_value
(String)role_arn
(String)Optional:
metric_timestamp
(String)topic_rule_payload.error_action.dynamo_d_bv_2
Optional:
put_item
(Attributes) (see below for nested schema)role_arn
(String)topic_rule_payload.error_action.dynamo_d_bv_2.put_item
Required:
table_name
(String)topic_rule_payload.error_action.dynamo_db
Required:
hash_key_field
(String)hash_key_value
(String)role_arn
(String)table_name
(String)Optional:
hash_key_type
(String)payload_field
(String)range_key_field
(String)range_key_type
(String)range_key_value
(String)topic_rule_payload.error_action.elasticsearch
Required:
endpoint
(String)id
(String)index
(String)role_arn
(String)type
(String)topic_rule_payload.error_action.firehose
Required:
delivery_stream_name
(String)role_arn
(String)Optional:
batch_mode
(Boolean)separator
(String)topic_rule_payload.error_action.http
Required:
url
(String)Optional:
auth
(Attributes) (see below for nested schema)confirmation_url
(String)headers
(Attributes List) (see below for nested schema)topic_rule_payload.error_action.http.auth
Optional:
sigv_4
(Attributes) (see below for nested schema)topic_rule_payload.error_action.http.headers.sigv_4
Required:
role_arn
(String)service_name
(String)signing_region
(String)topic_rule_payload.error_action.http.headers
Required:
key
(String)value
(String)topic_rule_payload.error_action.iot_analytics
Required:
channel_name
(String)role_arn
(String)Optional:
batch_mode
(Boolean)topic_rule_payload.error_action.iot_events
Required:
input_name
(String)role_arn
(String)Optional:
batch_mode
(Boolean)message_id
(String)topic_rule_payload.error_action.iot_site_wise
Required:
put_asset_property_value_entries
(Attributes List) (see below for nested schema)role_arn
(String)topic_rule_payload.error_action.iot_site_wise.put_asset_property_value_entries
Required:
property_values
(Attributes List) (see below for nested schema)Optional:
asset_id
(String)entry_id
(String)property_alias
(String)property_id
(String)topic_rule_payload.error_action.iot_site_wise.role_arn.property_values
Required:
timestamp
(Attributes) (see below for nested schema)value
(Attributes) (see below for nested schema)Optional:
quality
(String)topic_rule_payload.error_action.iot_site_wise.role_arn.property_values.timestamp
Required:
time_in_seconds
(String)Optional:
offset_in_nanos
(String)topic_rule_payload.error_action.iot_site_wise.role_arn.property_values.value
Optional:
boolean_value
(String)double_value
(String)integer_value
(String)string_value
(String)topic_rule_payload.error_action.kafka
Required:
client_properties
(Map of String)destination_arn
(String)topic
(String)Optional:
headers
(Attributes List) (see below for nested schema)key
(String)partition
(String)topic_rule_payload.error_action.kafka.headers
Required:
key
(String)value
(String)topic_rule_payload.error_action.kinesis
Required:
role_arn
(String)stream_name
(String)Optional:
partition_key
(String)topic_rule_payload.error_action.lambda
Optional:
function_arn
(String)topic_rule_payload.error_action.location
Required:
device_id
(String)latitude
(String)longitude
(String)role_arn
(String)tracker_name
(String)Optional:
timestamp
(Attributes) (see below for nested schema)topic_rule_payload.error_action.location.timestamp
Required:
value
(String)Optional:
unit
(String)topic_rule_payload.error_action.open_search
Required:
endpoint
(String)id
(String)index
(String)role_arn
(String)type
(String)topic_rule_payload.error_action.republish
Required:
role_arn
(String)topic
(String)Optional:
headers
(Attributes) (see below for nested schema)qos
(Number)topic_rule_payload.error_action.republish.headers
Optional:
content_type
(String)correlation_data
(String)message_expiry
(String)payload_format_indicator
(String)response_topic
(String)user_properties
(Attributes List) (see below for nested schema)topic_rule_payload.error_action.republish.qos.user_properties
Required:
key
(String)value
(String)topic_rule_payload.error_action.s3
Required:
bucket_name
(String)key
(String)role_arn
(String)Optional:
canned_acl
(String)topic_rule_payload.error_action.sns
Required:
role_arn
(String)target_arn
(String)Optional:
message_format
(String)topic_rule_payload.error_action.sqs
Required:
queue_url
(String)role_arn
(String)Optional:
use_base_64
(Boolean)topic_rule_payload.error_action.step_functions
Required:
role_arn
(String)state_machine_name
(String)Optional:
execution_name_prefix
(String)topic_rule_payload.error_action.timestream
Required:
database_name
(String)dimensions
(Attributes List) (see below for nested schema)role_arn
(String)table_name
(String)Optional:
timestamp
(Attributes) (see below for nested schema)topic_rule_payload.error_action.timestream.dimensions
Required:
name
(String)value
(String)topic_rule_payload.error_action.timestream.timestamp
Required:
unit
(String)value
(String)tags
Required:
key
(String)value
(String)Import is supported using the following syntax:
$ terraform import awscc_iot_topic_rule.example <resource ID>