AWS::IoT::TopicRule

IoT TopicRule

Resource Type definition for AWS::IoT::TopicRule

Properties

3 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`TopicRulePayload`	`TopicRulePayload`	Required
`RuleName`	`string`	Create-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Arn`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::IoT::TopicRule

Resources:
  MyResource:
    Type: AWS::IoT::TopicRule
    Properties:
      TopicRulePayload: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iam:PassRoleiot:CreateTopicRuleiot:GetTopicRuleiot:TagResourceiot:ListTagsForResource

read

iot:GetTopicRuleiot:ListTagsForResource

update

iam:PassRoleiot:GetTopicRuleiot:ListTagsForResourceiot:ReplaceTopicRuleiot:TagResourceiot:UntagResource

delete

iot:GetTopicRuleiot:DeleteTopicRule

list

iot:ListTopicRules

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceIoT

Properties4

Required1

TaggingSupported

Primary IDRuleName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

RuleName

Related Resources

External Links

AWS Documentation