Package software.amazon.awscdk.services.iot

Class TopicRule.Builder

java.lang.Object
software.amazon.awscdk.services.iot.TopicRule.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<TopicRule>
Enclosing class:
TopicRule
@Stability(Experimental) public static final class TopicRule.Builder extends Object implements software.amazon.jsii.Builder<TopicRule>
(experimental) A fluent builder for TopicRule.

  • Method Details

    • create

      @Stability(Experimental) public static TopicRule.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of TopicRule.Builder.

    • sql

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

      Parameters:
      sql - A simplified SQL syntax to filter messages received on an MQTT topic and push the data elsewhere. This parameter is required.
      Returns:
      this
      See Also:

    • actions

      @Stability(Experimental) public TopicRule.Builder actions(List<? extends IAction> actions)
      (experimental) The actions associated with the topic rule.

      Default: No actions will be perform

      Parameters:
      actions - The actions associated with the topic rule. This parameter is required.
      Returns:
      this

    • description

      @Stability(Experimental) public TopicRule.Builder description(String description)
      (experimental) A textual description of the topic rule.

      Default: None

      Parameters:
      description - A textual description of the topic rule. This parameter is required.
      Returns:
      this

    • enabled

      @Stability(Experimental) public TopicRule.Builder enabled(Boolean enabled)
      (experimental) Specifies whether the rule is enabled.

      Default: true

      Parameters:
      enabled - Specifies whether the rule is enabled. This parameter is required.
      Returns:
      this

    • errorAction

      @Stability(Experimental) public TopicRule.Builder errorAction(IAction errorAction)
      (experimental) The action AWS IoT performs when it is unable to perform a rule's action.

      Default: - no action will be performed

      Parameters:
      errorAction - The action AWS IoT performs when it is unable to perform a rule's action. This parameter is required.
      Returns:
      this

    • topicRuleName

      @Stability(Experimental) public TopicRule.Builder topicRuleName(String topicRuleName)
      (experimental) The name of the topic rule.

      Default: None

      Parameters:
      topicRuleName - The name of the topic rule. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public TopicRule build()
      Specified by:
      build in interface software.amazon.jsii.Builder<TopicRule>
      Returns:
      a newly built instance of TopicRule.