Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using disable_rule
.
See https://www.paws-r-sdk.com/docs/eventbridge_put_rule/ for full documentation.
eventbridge_put_rule(
Name,
ScheduleExpression = NULL,
EventPattern = NULL,
State = NULL,
Description = NULL,
RoleArn = NULL,
Tags = NULL,
EventBusName = NULL
)
[required] The name of the rule that you are creating or updating.
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
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.
A description of the rule.
The Amazon Resource Name (ARN) of the IAM role associated with the rule.
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.
The list of key-value pairs to associate with the rule.
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.