Class: Aws::IoT::Types::TopicRulePayload

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::TopicRulePayload

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Describes a rule.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actions ⇒ Array<Types::Action>

  The actions associated with the rule.

• #aws_iot_sql_version ⇒ String

  The version of the SQL rules engine to use when evaluating the rule.

• #description ⇒ String

  The description of the rule.

• #error_action ⇒ Types::Action

  The action to take when an error occurs.

• #rule_disabled ⇒ Boolean

  Specifies whether the rule is disabled.

• #sql ⇒ String

  The SQL statement used to query the topic.

Instance Attribute Details

#actions ⇒ Array<Types::Action>

The actions associated with the rule.

Returns:

• (Array<Types::Action>)

# File 'lib/aws-sdk-iot/types.rb', line 15711

class TopicRulePayload < Struct.new(
  :sql,
  :description,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version,
  :error_action)
  SENSITIVE = []
  include Aws::Structure
end

#aws_iot_sql_version ⇒ String

The version of the SQL rules engine to use when evaluating the rule.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 15711

class TopicRulePayload < Struct.new(
  :sql,
  :description,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version,
  :error_action)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the rule.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 15711

class TopicRulePayload < Struct.new(
  :sql,
  :description,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version,
  :error_action)
  SENSITIVE = []
  include Aws::Structure
end

#error_action ⇒ Types::Action

The action to take when an error occurs.

Returns:

• (Types::Action)

# File 'lib/aws-sdk-iot/types.rb', line 15711

class TopicRulePayload < Struct.new(
  :sql,
  :description,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version,
  :error_action)
  SENSITIVE = []
  include Aws::Structure
end

#rule_disabled ⇒ Boolean

Specifies whether the rule is disabled.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 15711

class TopicRulePayload < Struct.new(
  :sql,
  :description,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version,
  :error_action)
  SENSITIVE = []
  include Aws::Structure
end

#sql ⇒ String

The SQL statement used to query the topic. For more information, see

IoT SQL Reference][1

in the *IoT Developer Guide*.

[1]: docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 15711

class TopicRulePayload < Struct.new(
  :sql,
  :description,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version,
  :error_action)
  SENSITIVE = []
  include Aws::Structure
end