Rule

Contains information about a rule in Amazon EventBridge.

Arn

The Amazon Resource Name (ARN) of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No

Description

The description of the rule.

Type: String

Length Constraints: Maximum length of 512.

Required: No

EventBusName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [/\.\-_A-Za-z0-9]+

Required: No

EventPattern

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

Type: String

Length Constraints: Maximum length of 4096.

Required: No

ManagedBy

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

Name

The name of the rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No

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.

Type: String

Length Constraints: Maximum length of 256.

Required: No

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 AWS management events delivered through CloudTrail.
ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including AWS management events delivered through CloudTrail.

Management events provide visibility into management operations that are performed on resources in your AWS 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 AWS 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.

Type: String

Valid Values: ENABLED | DISABLED | ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS

Required: No

Rule

Contents

See Also