class Aws::IoT::Types::CreateTopicRuleRequest

@return [String]
</note>
“key1=value1&amp;key2=value2…”
For the cli-input-json file use format: “tags”:
“key1=value1&amp;key2=value2…”
For the CLI command-line parameter use format: –tags
…key1=value1&amp;key2=value2…
<note markdown=“1”> For URI Request parameters use format:
Metadata which can be used to manage the topic rule.
@!attribute [rw] tags
@return [Types::TopicRulePayload]
The rule payload.
@!attribute [rw] topic_rule_payload
@return [String]
The name of the rule.
@!attribute [rw] rule_name
}
tags: “String”,
},
},
},
id: “ElasticsearchId”, # required
type: “ElasticsearchType”, # required
index: “ElasticsearchIndex”, # required
endpoint: “ElasticsearchEndpoint”, # required
role_arn: “AwsArn”, # required
open_search: {
},
},
“String” => “String”,
client_properties: { # required
partition: “String”,
key: “String”,
topic: “String”, # required
destination_arn: “AwsArn”, # required
kafka: {
},
},
},
role_arn: “AwsArn”, # required
service_name: “ServiceName”, # required
signing_region: “SigningRegion”, # required
sigv4: {
auth: {
],
},
value: “HeaderValue”, # required
key: “HeaderKey”, # required
{
headers: [
confirmation_url: “Url”,
url: “Url”, # required
http: {
},
},
unit: “TimestreamTimestampUnit”, # required
value: “TimestreamTimestampValue”, # required
timestamp: {
],
},
value: “TimestreamDimensionValue”, # required
name: “TimestreamDimensionName”, # required
{
dimensions: [ # required
table_name: “TimestreamTableName”, # required
database_name: “TimestreamDatabaseName”, # required
role_arn: “AwsArn”, # required
timestream: {
},
role_arn: “AwsArn”, # required
state_machine_name: “StateMachineName”, # required
execution_name_prefix: “ExecutionNamePrefix”,
step_functions: {
},
role_arn: “AwsArn”, # required
],
},
],
},
quality: “AssetPropertyQuality”,
},
offset_in_nanos: “AssetPropertyOffsetInNanos”,
time_in_seconds: “AssetPropertyTimeInSeconds”, # required
timestamp: { # required
},
boolean_value: “AssetPropertyBooleanValue”,
double_value: “AssetPropertyDoubleValue”,
integer_value: “AssetPropertyIntegerValue”,
string_value: “AssetPropertyStringValue”,
value: { # required
{
property_values: [ # required
property_alias: “AssetPropertyAlias”,
property_id: “AssetPropertyId”,
asset_id: “AssetId”,
entry_id: “AssetPropertyEntryId”,
{
put_asset_property_value_entries: [ # required
iot_site_wise: {
},
role_arn: “AwsArn”, # required
batch_mode: false,
message_id: “MessageId”,
input_name: “InputName”, # required
iot_events: {
},
role_arn: “AwsArn”,
batch_mode: false,
channel_name: “ChannelName”,
channel_arn: “AwsArn”,
iot_analytics: {
},
url: “SalesforceEndpoint”, # required
token: “SalesforceToken”, # required
salesforce: {
},
id: “ElasticsearchId”, # required
type: “ElasticsearchType”, # required
index: “ElasticsearchIndex”, # required
endpoint: “ElasticsearchEndpoint”, # required
role_arn: “AwsArn”, # required
elasticsearch: {
},
log_group_name: “LogGroupName”, # required
role_arn: “AwsArn”, # required
cloudwatch_logs: {
},
state_value: “StateValue”, # required
state_reason: “StateReason”, # required
alarm_name: “AlarmName”, # required
role_arn: “AwsArn”, # required
cloudwatch_alarm: {
},
metric_timestamp: “String”,
metric_unit: “String”, # required
metric_value: “String”, # required
metric_name: “String”, # required
metric_namespace: “String”, # required
role_arn: “AwsArn”, # required
cloudwatch_metric: {
},
batch_mode: false,
separator: “FirehoseSeparator”,
delivery_stream_name: “DeliveryStreamName”, # required
role_arn: “AwsArn”, # required
firehose: {
},
canned_acl: “private”, # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write
key: “Key”, # required
bucket_name: “BucketName”, # required
role_arn: “AwsArn”, # required
s3: {
},
qos: 1,
topic: “TopicPattern”, # required
role_arn: “AwsArn”, # required
republish: {
},
partition_key: “PartitionKey”,
stream_name: “StreamName”, # required
role_arn: “AwsArn”, # required
kinesis: {
},
use_base_64: false,
queue_url: “QueueUrl”, # required
role_arn: “AwsArn”, # required
sqs: {
},
message_format: “RAW”, # accepts RAW, JSON
role_arn: “AwsArn”, # required
target_arn: “AwsArn”, # required
sns: {
},
function_arn: “FunctionArn”, # required
lambda: {
},
},
table_name: “TableName”, # required
put_item: { # required
role_arn: “AwsArn”, # required
dynamo_d_bv_2: {
},
payload_field: “PayloadField”,
range_key_type: “STRING”, # accepts STRING, NUMBER
range_key_value: “RangeKeyValue”,
range_key_field: “RangeKeyField”,
hash_key_type: “STRING”, # accepts STRING, NUMBER
hash_key_value: “HashKeyValue”, # required
hash_key_field: “HashKeyField”, # required
operation: “DynamoOperation”,
role_arn: “AwsArn”, # required
table_name: “TableName”, # required
dynamo_db: {
error_action: {
aws_iot_sql_version: “AwsIotSqlVersion”,
rule_disabled: false,
],
},
},
id: “ElasticsearchId”, # required
type: “ElasticsearchType”, # required
index: “ElasticsearchIndex”, # required
endpoint: “ElasticsearchEndpoint”, # required
role_arn: “AwsArn”, # required
open_search: {
},
},
“String” => “String”,
client_properties: { # required
partition: “String”,
key: “String”,
topic: “String”, # required
destination_arn: “AwsArn”, # required
kafka: {
},
},
},
role_arn: “AwsArn”, # required
service_name: “ServiceName”, # required
signing_region: “SigningRegion”, # required
sigv4: {
auth: {
],
},
value: “HeaderValue”, # required
key: “HeaderKey”, # required
{
headers: [
confirmation_url: “Url”,
url: “Url”, # required
http: {
},
},
unit: “TimestreamTimestampUnit”, # required
value: “TimestreamTimestampValue”, # required
timestamp: {
],
},
value: “TimestreamDimensionValue”, # required
name: “TimestreamDimensionName”, # required
{
dimensions: [ # required
table_name: “TimestreamTableName”, # required
database_name: “TimestreamDatabaseName”, # required
role_arn: “AwsArn”, # required
timestream: {
},
role_arn: “AwsArn”, # required
state_machine_name: “StateMachineName”, # required
execution_name_prefix: “ExecutionNamePrefix”,
step_functions: {
},
role_arn: “AwsArn”, # required
],
},
],
},
quality: “AssetPropertyQuality”,
},
offset_in_nanos: “AssetPropertyOffsetInNanos”,
time_in_seconds: “AssetPropertyTimeInSeconds”, # required
timestamp: { # required
},
boolean_value: “AssetPropertyBooleanValue”,
double_value: “AssetPropertyDoubleValue”,
integer_value: “AssetPropertyIntegerValue”,
string_value: “AssetPropertyStringValue”,
value: { # required
{
property_values: [ # required
property_alias: “AssetPropertyAlias”,
property_id: “AssetPropertyId”,
asset_id: “AssetId”,
entry_id: “AssetPropertyEntryId”,
{
put_asset_property_value_entries: [ # required
iot_site_wise: {
},
role_arn: “AwsArn”, # required
batch_mode: false,
message_id: “MessageId”,
input_name: “InputName”, # required
iot_events: {
},
role_arn: “AwsArn”,
batch_mode: false,
channel_name: “ChannelName”,
channel_arn: “AwsArn”,
iot_analytics: {
},
url: “SalesforceEndpoint”, # required
token: “SalesforceToken”, # required
salesforce: {
},
id: “ElasticsearchId”, # required
type: “ElasticsearchType”, # required
index: “ElasticsearchIndex”, # required
endpoint: “ElasticsearchEndpoint”, # required
role_arn: “AwsArn”, # required
elasticsearch: {
},
log_group_name: “LogGroupName”, # required
role_arn: “AwsArn”, # required
cloudwatch_logs: {
},
state_value: “StateValue”, # required
state_reason: “StateReason”, # required
alarm_name: “AlarmName”, # required
role_arn: “AwsArn”, # required
cloudwatch_alarm: {
},
metric_timestamp: “String”,
metric_unit: “String”, # required
metric_value: “String”, # required
metric_name: “String”, # required
metric_namespace: “String”, # required
role_arn: “AwsArn”, # required
cloudwatch_metric: {
},
batch_mode: false,
separator: “FirehoseSeparator”,
delivery_stream_name: “DeliveryStreamName”, # required
role_arn: “AwsArn”, # required
firehose: {
},
canned_acl: “private”, # accepts private, public-read, public-read-write, aws-exec-read, authenticated-read, bucket-owner-read, bucket-owner-full-control, log-delivery-write
key: “Key”, # required
bucket_name: “BucketName”, # required
role_arn: “AwsArn”, # required
s3: {
},
qos: 1,
topic: “TopicPattern”, # required
role_arn: “AwsArn”, # required
republish: {
},
partition_key: “PartitionKey”,
stream_name: “StreamName”, # required
role_arn: “AwsArn”, # required
kinesis: {
},
use_base_64: false,
queue_url: “QueueUrl”, # required
role_arn: “AwsArn”, # required
sqs: {
},
message_format: “RAW”, # accepts RAW, JSON
role_arn: “AwsArn”, # required
target_arn: “AwsArn”, # required
sns: {
},
function_arn: “FunctionArn”, # required
lambda: {
},
},
table_name: “TableName”, # required
put_item: { # required
role_arn: “AwsArn”, # required
dynamo_d_bv_2: {
},
payload_field: “PayloadField”,
range_key_type: “STRING”, # accepts STRING, NUMBER
range_key_value: “RangeKeyValue”,
range_key_field: “RangeKeyField”,
hash_key_type: “STRING”, # accepts STRING, NUMBER
hash_key_value: “HashKeyValue”, # required
hash_key_field: “HashKeyField”, # required
operation: “DynamoOperation”,
role_arn: “AwsArn”, # required
table_name: “TableName”, # required
dynamo_db: {
{
actions: [ # required
description: “Description”,
sql: “SQL”, # required
topic_rule_payload: { # required
rule_name: “RuleName”, # required
{
data as a hash:
@note When making an API call, you may pass CreateTopicRuleRequest
The input for the CreateTopicRule operation.