Experimental

@aws-cdk/aws-iot-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

TopicRule L2 construct

Defines an AWS IoT Rule in this stack.

Stability: Experimental
Source: lib/topic-rule.ts

Example

import * as sns from 'aws-cdk-lib/aws-sns';

const topic = new sns.Topic(this, 'MyTopic');

const topicRule = new iot.TopicRule(this, 'TopicRule', {
  sql: iot.IotSql.fromStringAsVer20160323(
    "SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'",
  ),
  actions: [
    new actions.SnsTopicAction(topic, {
      messageFormat: actions.SnsActionMessageFormat.JSON, // optional property, default is SnsActionMessageFormat.RAW
    }),
  ],
});

python

import aws_cdk.aws_sns as sns


topic = sns.Topic(self, "MyTopic")

topic_rule = iot.TopicRule(self, "TopicRule",
    sql=iot.IotSql.from_string_as_ver20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'"),
    actions=[
        actions.SnsTopicAction(topic,
            message_format=actions.SnsActionMessageFormat.JSON
        )
    ]
)

java

import software.amazon.awscdk.services.sns.*;


Topic topic = new Topic(this, "MyTopic");

TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
        .sql(IotSql.fromStringAsVer20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'"))
        .actions(List.of(
            SnsTopicAction.Builder.create(topic)
                    .messageFormat(SnsActionMessageFormat.JSON)
                    .build()))
        .build();

csharp

// Install: dotnet add package Amazon.CDK.AWS.IoT.Alpha
using Amazon.CDK.AWS.SNS;


var topic = new Topic(this, "MyTopic");

var topicRule = new TopicRule(this, "TopicRule", new TopicRuleProps {
    Sql = IotSql.FromStringAsVer20160323("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'"),
    Actions = new [] {
        new SnsTopicAction(topic, new SnsTopicActionProps {
            MessageFormat = SnsActionMessageFormat.JSON
        }) }
});

// Install: go get github.com/aws/aws-cdk-go/awscdkiotalpha/v2
import sns "github.com/aws/aws-cdk-go/awscdk"


topic := sns.NewTopic(this, jsii.String("MyTopic"))

topicRule := iot.NewTopicRule(this, jsii.String("TopicRule"), &TopicRuleProps{
	Sql: iot.IotSql_FromStringAsVer20160323(jsii.String("SELECT topic(2) as device_id, year, month, day FROM 'device/+/data'")),
	Actions: []IAction{
		actions.NewSnsTopicAction(topic, &SnsTopicActionProps{
			MessageFormat: actions.SnsActionMessageFormat_JSON,
		}),
	},
})

Initializer

new TopicRule(scope: Construct, id: string, props: TopicRuleProps)

python

TopicRule(scope: Construct, id: str, props: TopicRuleProps)

java

new TopicRule(Construct scope, String id, TopicRuleProps props)

csharp

new TopicRule(Construct scope, string id, TopicRuleProps props)

NewTopicRule(Scope Construct, Id *string, Props TopicRuleProps)

Construct Props

actionsIAction[]actionstyping.List[IAction]actionsList<IAction>ActionsIAction[]Actions*[]IAction= No actions will be perform#

The actions associated with the topic rule.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= None#

A textual description of the topic rule.

enabledbooleanenabledboolenabledBooleanEnabledboolEnabled*bool= true#

Specifies whether the rule is enabled.

errorActionIActionerror_actionIActionerrorActionIActionErrorActionIActionErrorActionIAction= no action will be performed#

The action AWS IoT performs when it is unable to perform a rule's action.

sqlIotSqlsqlIotSqlsqlIotSqlSqlIotSqlSqlIotSqlrequired#

A simplified SQL syntax to filter messages received on an MQTT topic and push the data elsewhere.

topicRuleNamestringtopic_rule_namestrtopicRuleNameStringTopicRuleNamestringTopicRuleName*string= None#

The name of the topic rule.

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

topicRuleArnstringtopic_rule_arnstrtopicRuleArnStringTopicRuleArnstringTopicRuleArn*stringrequired#

Arn of this topic rule.

topicRuleNamestringtopic_rule_namestrtopicRuleNameStringTopicRuleNamestringTopicRuleName*stringrequired#

Name of this topic rule.

Methods

addAction(action: IAction): voiddef add_action(self, action: IAction) -> Nonepublic void addAction(IAction action)public void AddAction(IAction action)func AddAction(Action IAction)#

Add a action to the topic rule.

1 parameter

Parameters

actionactionactionactionAction — the action to associate with the topic rule.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromTopicRuleArn(scope: Construct, id: string, topicRuleArn: string): ITopicRule@staticmethod def from_topic_rule_arn(scope: Construct, id: str, topic_rule_arn: str) -> ITopicRulepublic static ITopicRule fromTopicRuleArn(Construct scope, String id, String topicRuleArn)public static ITopicRule FromTopicRuleArn(Construct scope, string id, string topicRuleArn)func FromTopicRuleArn(Scope Construct, Id *string, TopicRuleArn *string) ITopicRulestatic#

Import an existing AWS IoT Rule provided an ARN.

3 parameters

Parameters

scopescopescopescopeScope — The parent creating construct (usually this).
ididididId — The construct's name.
topicRuleArntopic_rule_arntopicRuleArntopicRuleArnTopicRuleArn — AWS IoT Rule ARN (i.e. arn:aws:iot:<region>:<account-id>:rule/MyRule).

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

TopicRule L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

TopicRule L2 construct

Example

Initializer

Construct Props

Properties

Methods