You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::TopicRule

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a rule.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ Array<Types::Action>

The actions associated with the rule.

Returns:

  • (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.

Returns:

  • (String) —

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

#created_at ⇒ Time

The date and time the rule was created.

Returns:

  • (Time) —

    The date and time the rule was created.

#description ⇒ String

The description of the rule.

Returns:

  • (String) —

    The description of the rule.

#error_action ⇒ Types::Action

The action to perform when an error occurs.

Returns:

  • (Types::Action) —

    The action to perform when an error occurs.

#rule_disabled ⇒ Boolean

Specifies whether the rule is disabled.

Returns:

  • (Boolean) —

    Specifies whether the rule is disabled.

#rule_name ⇒ String

The name of the rule.

Returns:

  • (String) —

    The name of the rule.

#sql ⇒ String

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

Returns:

  • (String) —

    The SQL statement used to query the topic.