class Aws::EventBridge::Types::Rule
Contains information about a rule in Amazon EventBridge
.
@!attribute [rw] name
The name of the rule. @return [String]
@!attribute [rw] arn
The Amazon Resource Name (ARN) of the rule. @return [String]
@!attribute [rw] event_pattern
The event pattern of the rule. For more information, see [Events and Event Patterns][1] in the *Amazon EventBridge User Guide*. [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html @return [String]
@!attribute [rw] state
The state of the rule. @return [String]
@!attribute [rw] description
The description of the rule. @return [String]
@!attribute [rw] schedule_expression
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][1]. [1]: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html @return [String]
@!attribute [rw] role_arn
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. @return [String]
@!attribute [rw] managed_by
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. @return [String]
@!attribute [rw] event_bus_name
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/eventbridge-2015-10-07/Rule AWS API Documentation
Constants
- SENSITIVE