TopicRule

class aws_cdk.aws_iot.TopicRule(scope, id, *, sql, actions=None, description=None, enabled=None, error_action=None, topic_rule_name=None)

Bases: Resource

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

Stability:: experimental
ExampleMetadata:: infused

Example:

bucket = s3.Bucket(self, "MyBucket")

iot.TopicRule(self, "TopicRule",
    sql=iot.IotSql.from_string_as_ver20160323("SELECT * FROM 'device/+/data'"),
    actions=[
        actions.S3PutObjectAction(bucket,
            access_control=s3.BucketAccessControl.PUBLIC_READ
        )
    ]
)

Parameters:

scope (Construct) –
id (str) –
sql (IotSql) – (experimental) A simplified SQL syntax to filter messages received on an MQTT topic and push the data elsewhere.
actions (Optional[Sequence[IAction]]) – (experimental) The actions associated with the topic rule. Default: No actions will be perform
description (Optional[str]) – (experimental) A textual description of the topic rule. Default: None
enabled (Optional[bool]) – (experimental) Specifies whether the rule is enabled. Default: true
error_action (Optional[IAction]) – (experimental) The action AWS IoT performs when it is unable to perform a rule’s action. Default: - no action will be performed
topic_rule_name (Optional[str]) – (experimental) The name of the topic rule. Default: None

Stability:

experimental

Methods

add_action(action)

(experimental) Add a action to the topic rule.

Parameters:: action (IAction) – the action to associate with the topic rule.
Stability:: experimental
Return type:: None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The construct tree node associated with this construct.

stack: The stack in which this resource is defined.

topic_rule_arn

(experimental) Arn of this topic rule.

Stability:: experimental
Attribute:: true

topic_rule_name

(experimental) Name of this topic rule.

Stability:: experimental
Attribute:: true

Static Methods

classmethod from_topic_rule_arn(scope, id, topic_rule_arn)

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

Parameters:

scope (Construct) – The parent creating construct (usually this).
id (str) – The construct’s name.
topic_rule_arn (str) – AWS IoT Rule ARN (i.e. arn:aws:iot:::rule/MyRule).

Stability:

experimental

Return type:

ITopicRule

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool