AWS SDK Version 3 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.

Container for the parameters to the PutRule operation. Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatchEvents.AmazonCloudWatchEventsRequest
      Amazon.CloudWatchEvents.Model.PutRuleRequest

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

Syntax

C#
public class PutRuleRequest : AmazonCloudWatchEventsRequest
         IAmazonWebServiceRequest

The PutRuleRequest type exposes the following members

Constructors

NameDescription
Public Method PutRuleRequest()

Properties

NameTypeDescription
Public Property Description System.String

Gets and sets the property Description.

A description of the rule.

Public Property EventPattern System.String

Gets and sets the property EventPattern.

The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

Public Property Name System.String

Gets and sets the property Name.

The name of the rule that you are creating or updating.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

Public Property ScheduleExpression System.String

Gets and sets the property ScheduleExpression.

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

Public Property State Amazon.CloudWatchEvents.RuleState

Gets and sets the property State.

Indicates whether the rule is enabled or disabled.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms