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.

Contains information about a rule in Amazon EventBridge.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatchEvents.Model.Rule

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

Syntax

C#
public class Rule

The Rule type exposes the following members

Constructors

NameDescription
Public Method Rule()

Properties

NameTypeDescription
Public Property Arn System.String

Gets and sets the property Arn.

The Amazon Resource Name (ARN) of the rule.

Public Property Description System.String

Gets and sets the property Description.

The description of the rule.

Public Property EventBusName System.String

Gets and sets the property EventBusName.

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Public Property EventPattern System.String

Gets and sets the property EventPattern.

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

Public Property ManagedBy System.String

Gets and sets the property ManagedBy.

If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.

Public Property Name System.String

Gets and sets the property Name.

The name of the rule.

Public Property RoleArn System.String

Gets and sets the property RoleArn.

The Amazon Resource Name (ARN) of the role that is used for target invocation.

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

Public Property ScheduleExpression System.String

Gets and sets the property ScheduleExpression.

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

Public Property State Amazon.CloudWatchEvents.RuleState

Gets and sets the property State.

The state of the rule.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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