Interface TopicRuleProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.726Z") @Stability(Experimental) public interface TopicRuleProps extends
(experimental) Properties for defining an AWS IoT Rule.


 Bucket bucket = new Bucket(this, "MyBucket");
 TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"))
  • Method Details

    • getSql

      @Stability(Experimental) @NotNull IotSql getSql()
      (experimental) A simplified SQL syntax to filter messages received on an MQTT topic and push the data elsewhere.

      See Also:
    • getActions

      @Stability(Experimental) @Nullable default List<IAction> getActions()
      (experimental) The actions associated with the topic rule.

      Default: No actions will be perform

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) A textual description of the topic rule.

      Default: None

    • getEnabled

      @Stability(Experimental) @Nullable default Boolean getEnabled()
      (experimental) Specifies whether the rule is enabled.

      Default: true

    • getErrorAction

      @Stability(Experimental) @Nullable default IAction getErrorAction()
      (experimental) The action AWS IoT performs when it is unable to perform a rule's action.

      Default: - no action will be performed

    • getTopicRuleName

      @Stability(Experimental) @Nullable default String getTopicRuleName()
      (experimental) The name of the topic rule.

      Default: None

    • builder

      @Stability(Experimental) static TopicRuleProps.Builder builder()
      a TopicRuleProps.Builder of TopicRuleProps