Package software.amazon.awscdk.services.iot

Interface CfnTopicRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-17T14:54:05.804Z")
@Stability(Stable)
public interface CfnTopicRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTopicRule.

Example:

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTopicRuleProps.Builder	A builder for CfnTopicRuleProps
static final class	CfnTopicRuleProps.Jsii$Proxy	An implementation for CfnTopicRuleProps

Method Summary

Modifier and Type	Method	Description
static CfnTopicRuleProps.Builder	builder()
default String	getRuleName()	The name of the rule.
default List<CfnTag>	getTags()	Metadata which can be used to manage the topic rule.
Object	getTopicRulePayload()	The rule payload.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTopicRulePayload

@Stability(Stable)
@NotNull
Object getTopicRulePayload()

The rule payload.

Returns union: either IResolvable or CfnTopicRule.TopicRulePayloadProperty

See Also:

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

getRuleName

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

The name of the rule.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

See Also:

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

builder

@Stability(Stable)
static CfnTopicRuleProps.Builder builder()

Returns:

a CfnTopicRuleProps.Builder of CfnTopicRuleProps