software.amazon.awscdk.services.iot

Class TopicRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.iot.TopicRule

All Implemented Interfaces:

IDependable, IResource, ITopicRule, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:50.510Z")
 @Stability(value=Experimental)
public class TopicRule
extends Resource
implements ITopicRule

(experimental) Defines an AWS IoT Rule in this stack.

Example:

 Bucket bucket = new Bucket(this, "MyBucket");
 TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"))
         .actions(List.of(
             S3PutObjectAction.Builder.create(bucket)
                     .accessControl(BucketAccessControl.PUBLIC_READ)
                     .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopicRule.Builder (experimental) A fluent builder for TopicRule.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

ITopicRule.Jsii$Default, ITopicRule.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	TopicRule(software.constructs.Construct scope, String id, TopicRuleProps props)
protected	TopicRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TopicRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addAction(IAction action) (experimental) Add a action to the topic rule.
static ITopicRule	fromTopicRuleArn(software.constructs.Construct scope, String id, String topicRuleArn) (experimental) Import an existing AWS IoT Rule provided an ARN.
String	getTopicRuleArn() (experimental) Arn of this topic rule.
String	getTopicRuleName() (experimental) Name of this topic rule.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

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.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

TopicRule

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

TopicRule

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

TopicRule

@Stability(value=Experimental)
public TopicRule(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                TopicRuleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromTopicRuleArn

@Stability(value=Experimental)
 @NotNull
public static ITopicRule fromTopicRuleArn(@NotNull
                                                                                   software.constructs.Construct scope,
                                                                                   @NotNull
                                                                                   String id,
                                                                                   @NotNull
                                                                                   String topicRuleArn)

(experimental) Import an existing AWS IoT Rule provided an ARN.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

topicRuleArn - AWS IoT Rule ARN (i.e. arn:aws:iot:::rule/MyRule). This parameter is required.

addAction

@Stability(value=Experimental)
public void addAction(@NotNull
                                                     IAction action)

(experimental) Add a action to the topic rule.

Parameters:

action - the action to associate with the topic rule. This parameter is required.

getTopicRuleArn

@Stability(value=Experimental)
 @NotNull
public String getTopicRuleArn()

(experimental) Arn of this topic rule.

Specified by:

getTopicRuleArn in interface ITopicRule

getTopicRuleName

@Stability(value=Experimental)
 @NotNull
public String getTopicRuleName()

(experimental) Name of this topic rule.

Specified by:

getTopicRuleName in interface ITopicRule