software.amazon.awscdk.services.iot

Class TopicRule

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.iot.TopicRule

All Implemented Interfaces:

IConstruct, IDependable, IResource, ITopicRule

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:15.628Z")
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 interface software.amazon.awscdk.services.iot.ITopicRule

ITopicRule.Jsii$Default, ITopicRule.Jsii$Proxy

Constructor Summary

Constructors

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

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, java.lang.String id, java.lang.String topicRuleArn) (experimental) Import an existing AWS IoT Rule provided an ARN.
java.lang.String	getTopicRuleArn() (experimental) Arn of this topic rule.
java.lang.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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Detail

TopicRule

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

TopicRule

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

TopicRule

public TopicRule(software.constructs.Construct scope,
                 java.lang.String id,
                 TopicRuleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromTopicRuleArn

public static ITopicRule fromTopicRuleArn(software.constructs.Construct scope,
                                          java.lang.String id,
                                          java.lang.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

public void addAction(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

public java.lang.String getTopicRuleArn()

(experimental) Arn of this topic rule.

Specified by:

getTopicRuleArn in interface ITopicRule

getTopicRuleName

public java.lang.String getTopicRuleName()

(experimental) Name of this topic rule.

Specified by:

getTopicRuleName in interface ITopicRule