AWS::IoT::TopicRule Action
Describes the actions associated with a rule.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "CloudwatchAlarm" :
CloudwatchAlarmAction
, "CloudwatchLogs" :CloudwatchLogsAction
, "CloudwatchMetric" :CloudwatchMetricAction
, "DynamoDB" :DynamoDBAction
, "DynamoDBv2" :DynamoDBv2Action
, "Elasticsearch" :ElasticsearchAction
, "Firehose" :FirehoseAction
, "Http" :HttpAction
, "IotAnalytics" :IotAnalyticsAction
, "IotEvents" :IotEventsAction
, "IotSiteWise" :IotSiteWiseAction
, "Kafka" :KafkaAction
, "Kinesis" :KinesisAction
, "Lambda" :LambdaAction
, "Location" :LocationAction
, "OpenSearch" :OpenSearchAction
, "Republish" :RepublishAction
, "S3" :S3Action
, "Sns" :SnsAction
, "Sqs" :SqsAction
, "StepFunctions" :StepFunctionsAction
, "Timestream" :TimestreamAction
}
YAML
CloudwatchAlarm:
CloudwatchAlarmAction
CloudwatchLogs:CloudwatchLogsAction
CloudwatchMetric:CloudwatchMetricAction
DynamoDB:DynamoDBAction
DynamoDBv2:DynamoDBv2Action
Elasticsearch:ElasticsearchAction
Firehose:FirehoseAction
Http:HttpAction
IotAnalytics:IotAnalyticsAction
IotEvents:IotEventsAction
IotSiteWise:IotSiteWiseAction
Kafka:KafkaAction
Kinesis:KinesisAction
Lambda:LambdaAction
Location:LocationAction
OpenSearch:OpenSearchAction
Republish:RepublishAction
S3:S3Action
Sns:SnsAction
Sqs:SqsAction
StepFunctions:StepFunctionsAction
Timestream:TimestreamAction
Properties
CloudwatchAlarm
-
Change the state of a CloudWatch alarm.
Required: No
Type: CloudwatchAlarmAction
Update requires: No interruption
CloudwatchLogs
-
Sends data to CloudWatch.
Required: No
Type: CloudwatchLogsAction
Update requires: No interruption
CloudwatchMetric
-
Capture a CloudWatch metric.
Required: No
Type: CloudwatchMetricAction
Update requires: No interruption
DynamoDB
-
Write to a DynamoDB table.
Required: No
Type: DynamoDBAction
Update requires: No interruption
DynamoDBv2
-
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.
Required: No
Type: DynamoDBv2Action
Update requires: No interruption
Elasticsearch
-
Write data to an Amazon OpenSearch Service domain.
Note
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 theOpenSearch
rule action instead. For more information, see OpenSearchAction.Required: No
Type: ElasticsearchAction
Update requires: No interruption
Firehose
-
Write to an Amazon Kinesis Firehose stream.
Required: No
Type: FirehoseAction
Update requires: No interruption
Http
-
Send data to an HTTPS endpoint.
Required: No
Type: HttpAction
Update requires: No interruption
IotAnalytics
-
Sends message data to an AWS IoT Analytics channel.
Required: No
Type: IotAnalyticsAction
Update requires: No interruption
IotEvents
-
Sends an input to an AWS IoT Events detector.
Required: No
Type: IotEventsAction
Update requires: No interruption
IotSiteWise
-
Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
Required: No
Type: IotSiteWiseAction
Update requires: No interruption
Kafka
-
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
Required: No
Type: KafkaAction
Update requires: No interruption
Kinesis
-
Write data to an Amazon Kinesis stream.
Required: No
Type: KinesisAction
Update requires: No interruption
Lambda
-
Invoke a Lambda function.
Required: No
Type: LambdaAction
Update requires: No interruption
Location
-
Sends device location data to Amazon Location Service.
Required: No
Type: LocationAction
Update requires: No interruption
OpenSearch
-
Write data to an Amazon OpenSearch Service domain.
Required: No
Type: OpenSearchAction
Update requires: No interruption
Republish
-
Publish to another MQTT topic.
Required: No
Type: RepublishAction
Update requires: No interruption
S3
-
Write to an Amazon S3 bucket.
Required: No
Type: S3Action
Update requires: No interruption
Sns
-
Publish to an Amazon SNS topic.
Required: No
Type: SnsAction
Update requires: No interruption
Sqs
-
Publish to an Amazon SQS queue.
Required: No
Type: SqsAction
Update requires: No interruption
StepFunctions
-
Starts execution of a Step Functions state machine.
Required: No
Type: StepFunctionsAction
Update requires: No interruption
Timestream
-
Writes attributes from an MQTT message.
Required: No
Type: TimestreamAction
Update requires: No interruption