Class Rule

Namespace

Amazon.EventBridge.Model

Assembly

AWSSDK.EventBridge.dll

Contains information about a rule in Amazon EventBridge.

public class Rule

Inheritance

object

Rule

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Rule()

public Rule()

Properties

Arn

Gets and sets the property Arn.

The Amazon Resource Name (ARN) of the rule.

public string Arn { get; set; }

Property Value

string

Description

Gets and sets the property Description.

The description of the rule.

public string Description { get; set; }

Property Value

string

EventBusName

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 string EventBusName { get; set; }

Property Value

string

EventPattern

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 string EventPattern { get; set; }

Property Value

string

ManagedBy

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 string ManagedBy { get; set; }

Property Value

string

Name

Gets and sets the property Name.

The name of the rule.

public string Name { get; set; }

Property Value

string

RoleArn

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 string RoleArn { get; set; }

Property Value

string

ScheduleExpression

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 string ScheduleExpression { get; set; }

Property Value

string

State

Gets and sets the property State.

The state of the rule.

Valid values include:

• DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

• ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

• ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

  Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .

  This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

public RuleState State { get; set; }

Property Value

RuleState