AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a rule.

Inheritance Hierarchy

System.Object
  Amazon.IoT.Model.TopicRule

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class TopicRule

The TopicRule type exposes the following members

Constructors

NameDescription
Public Method TopicRule()

Properties

NameTypeDescription
Public Property Actions System.Collections.Generic.List<Amazon.IoT.Model.Action>

Gets and sets the property Actions.

The actions associated with the rule.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property AwsIotSqlVersion System.String

Gets and sets the property AwsIotSqlVersion.

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

Public Property CreatedAt System.Nullable<System.DateTime>

Gets and sets the property CreatedAt.

The date and time the rule was created.

Public Property Description System.String

Gets and sets the property Description.

The description of the rule.

Public Property ErrorAction Amazon.IoT.Model.Action

Gets and sets the property ErrorAction.

The action to perform when an error occurs.

Public Property RuleDisabled System.Nullable<System.Boolean>

Gets and sets the property RuleDisabled.

Specifies whether the rule is disabled.

Public Property RuleName System.String

Gets and sets the property RuleName.

The name of the rule.

Public Property Sql System.String

Gets and sets the property Sql.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer