Package software.amazon.awscdk.services.iot

Class CfnTopicRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnTopicRule

All Implemented Interfaces:

IInspectable, IEnvironmentAware, ITopicRuleRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-17T14:54:05.766Z")
@Stability(Stable)
public class CfnTopicRule
extends CfnResource
implements IInspectable, ITopicRuleRef, ITaggable

Use the AWS::IoT::TopicRule resource to declare an AWS IoT rule.

For information about working with AWS IoT rules, see Rules for AWS IoT in the AWS IoT Developer Guide .

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-topicrule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnTopicRule.ActionProperty	Describes the actions associated with a rule.
static interface	CfnTopicRule.AssetPropertyTimestampProperty	An asset property timestamp entry containing the following information.
static interface	CfnTopicRule.AssetPropertyValueProperty	An asset property value entry containing the following information.
static interface	CfnTopicRule.AssetPropertyVariantProperty	Contains an asset property value (of a single type).
static interface	CfnTopicRule.BatchConfigProperty	Example:
static final class	CfnTopicRule.Builder	A fluent builder for CfnTopicRule.
static interface	CfnTopicRule.CloudwatchAlarmActionProperty	Describes an action that updates a CloudWatch alarm.
static interface	CfnTopicRule.CloudwatchLogsActionProperty	Describes an action that updates a CloudWatch log.
static interface	CfnTopicRule.CloudwatchMetricActionProperty	Describes an action that captures a CloudWatch metric.
static interface	CfnTopicRule.DynamoDBActionProperty	Describes an action to write to a DynamoDB table.
static interface	CfnTopicRule.DynamoDBv2ActionProperty	Describes an action to write to a DynamoDB table.
static interface	CfnTopicRule.ElasticsearchActionProperty	Describes an action that writes data to an Amazon OpenSearch Service domain.
static interface	CfnTopicRule.FirehoseActionProperty	Describes an action that writes data to an Amazon Kinesis Firehose stream.
static interface	CfnTopicRule.HttpActionHeaderProperty	The HTTP action header.
static interface	CfnTopicRule.HttpActionProperty	Send data to an HTTPS endpoint.
static interface	CfnTopicRule.HttpAuthorizationProperty	The authorization method used to send messages.
static interface	CfnTopicRule.InfluxDBActionProperty	Example:
static interface	CfnTopicRule.InfluxDBBatchConfigProperty	Example:
static interface	CfnTopicRule.IotAnalyticsActionProperty	Sends message data to an AWS IoT Analytics channel.
static interface	CfnTopicRule.IotEventsActionProperty	Sends an input to an AWS IoT Events detector.
static interface	CfnTopicRule.IotSiteWiseActionProperty	Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
static interface	CfnTopicRule.KafkaActionHeaderProperty	Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action.
static interface	CfnTopicRule.KafkaActionProperty	Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
static interface	CfnTopicRule.KinesisActionProperty	Describes an action to write data to an Amazon Kinesis stream.
static interface	CfnTopicRule.LambdaActionProperty	Describes an action to invoke a Lambda function.
static interface	CfnTopicRule.LocationActionProperty	Describes an action to send device location updates from an MQTT message to an Amazon Location tracker resource.
static interface	CfnTopicRule.OpenSearchActionProperty	Describes an action that writes data to an Amazon OpenSearch Service domain.
static interface	CfnTopicRule.PutAssetPropertyValueEntryProperty	An asset property value entry containing the following information.
static interface	CfnTopicRule.PutItemInputProperty	The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
static interface	CfnTopicRule.RepublishActionHeadersProperty	Specifies MQTT Version 5.0 headers information.
static interface	CfnTopicRule.RepublishActionProperty	Describes an action to republish to another topic.
static interface	CfnTopicRule.S3ActionProperty	Describes an action to write data to an Amazon S3 bucket.
static interface	CfnTopicRule.SigV4AuthorizationProperty	For more information, see Signature Version 4 signing process .
static interface	CfnTopicRule.SnsActionProperty	Describes an action to publish to an Amazon SNS topic.
static interface	CfnTopicRule.SqsActionProperty	Describes an action to publish data to an Amazon SQS queue.
static interface	CfnTopicRule.StepFunctionsActionProperty	Starts execution of a Step Functions state machine.
static interface	CfnTopicRule.TimestampProperty	Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
static interface	CfnTopicRule.TimestreamActionProperty	Describes an action that writes records into an Amazon Timestream table.
static interface	CfnTopicRule.TimestreamDimensionProperty	Metadata attributes of the time series that are written in each measure record.
static interface	CfnTopicRule.TimestreamTimestampProperty	The value to use for the entry's timestamp.
static interface	CfnTopicRule.TopicRulePayloadProperty	Describes a rule.
static interface	CfnTopicRule.UserPropertyProperty	A key-value pair that you define in the header.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.iot.ITopicRuleRef

ITopicRuleRef.Jsii$Default, ITopicRuleRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTopicRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTopicRule(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTopicRule(software.constructs.Construct scope, String id, CfnTopicRuleProps props)	Create a new AWS::IoT::TopicRule.

Method Summary

Modifier and Type	Method	Description
static String	arnForTopicRule(ITopicRuleRef resource)
static ITopicRuleRef	fromRuleName(software.constructs.Construct scope, String id, String ruleName)	Creates a new ITopicRuleRef from a ruleName.
static ITopicRuleRef	fromTopicRuleArn(software.constructs.Construct scope, String id, String arn)	Creates a new ITopicRuleRef from an ARN.
String	getAttrArn()	The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
String	getRuleName()	The name of the rule.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Metadata which can be used to manage the topic rule.
Object	getTopicRulePayload()	The rule payload.
TopicRuleReference	getTopicRuleRef()	A reference to a TopicRule resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnTopicRule(Object x)	Checks whether the given object is a CfnTopicRule.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setRuleName(String value)	The name of the rule.
void	setTagsRaw(List<CfnTag> value)	Metadata which can be used to manage the topic rule.
void	setTopicRulePayload(IResolvable value)	The rule payload.
void	setTopicRulePayload(CfnTopicRule.TopicRulePayloadProperty value)	The rule payload.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, addResourceDependency, addResourceDependency, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, removeDependency, removeResourceDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTopicRule

protected CfnTopicRule(software.amazon.jsii.JsiiObjectRef objRef)

CfnTopicRule

protected CfnTopicRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTopicRule

@Stability(Stable)
public CfnTopicRule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTopicRuleProps props)

Create a new AWS::IoT::TopicRule.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForTopicRule

@Stability(Stable)
@NotNull
public static String arnForTopicRule(@NotNull
 ITopicRuleRef resource)

Parameters:

resource - This parameter is required.

fromRuleName

@Stability(Stable)
@NotNull
public static ITopicRuleRef fromRuleName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String ruleName)

Creates a new ITopicRuleRef from a ruleName.

Parameters:

scope - This parameter is required.

id - This parameter is required.

ruleName - This parameter is required.

fromTopicRuleArn

@Stability(Stable)
@NotNull
public static ITopicRuleRef fromTopicRuleArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String arn)

Creates a new ITopicRuleRef from an ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

arn - This parameter is required.

isCfnTopicRule

@Stability(Stable)
@NotNull
public static Boolean isCfnTopicRule(@NotNull
 Object x)

Checks whether the given object is a CfnTopicRule.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the AWS IoT rule, such as arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getTopicRuleRef

@Stability(Stable)
@NotNull
public TopicRuleReference getTopicRuleRef()

A reference to a TopicRule resource.

Specified by:

getTopicRuleRef in interface ITopicRuleRef

getTopicRulePayload

@Stability(Stable)
@NotNull
public Object getTopicRulePayload()

The rule payload.

Returns union: either IResolvable or CfnTopicRule.TopicRulePayloadProperty

setTopicRulePayload

@Stability(Stable)
public void setTopicRulePayload(@NotNull
 IResolvable value)

The rule payload.

setTopicRulePayload

@Stability(Stable)
public void setTopicRulePayload(@NotNull
 CfnTopicRule.TopicRulePayloadProperty value)

The rule payload.

getRuleName

@Stability(Stable)
@Nullable
public String getRuleName()

The name of the rule.

setRuleName

@Stability(Stable)
public void setRuleName(@Nullable
 String value)

The name of the rule.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Metadata which can be used to manage the topic rule.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Metadata which can be used to manage the topic rule.