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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Describes a rule.

Instance Attribute Summary collapse

Instance Attribute Details

#actionsArray<Types::Action>

The actions associated with the rule.

Returns:



3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3185

class TopicRule < Struct.new(
  :rule_name,
  :sql,
  :description,
  :created_at,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version)
  include Aws::Structure
end

#aws_iot_sql_versionString

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

Returns:

  • (String)


3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3185

class TopicRule < Struct.new(
  :rule_name,
  :sql,
  :description,
  :created_at,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version)
  include Aws::Structure
end

#created_atTime

The date and time the rule was created.

Returns:

  • (Time)


3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3185

class TopicRule < Struct.new(
  :rule_name,
  :sql,
  :description,
  :created_at,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version)
  include Aws::Structure
end

#descriptionString

The description of the rule.

Returns:

  • (String)


3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3185

class TopicRule < Struct.new(
  :rule_name,
  :sql,
  :description,
  :created_at,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version)
  include Aws::Structure
end

#rule_disabledBoolean

Specifies whether the rule is disabled.

Returns:

  • (Boolean)


3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3185

class TopicRule < Struct.new(
  :rule_name,
  :sql,
  :description,
  :created_at,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version)
  include Aws::Structure
end

#rule_nameString

The name of the rule.

Returns:

  • (String)


3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3185

class TopicRule < Struct.new(
  :rule_name,
  :sql,
  :description,
  :created_at,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version)
  include Aws::Structure
end

#sqlString

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)


3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3185

class TopicRule < Struct.new(
  :rule_name,
  :sql,
  :description,
  :created_at,
  :actions,
  :rule_disabled,
  :aws_iot_sql_version)
  include Aws::Structure
end