cloudwatchevents_put_rule: Creates or updates the specified rule

View source: R/cloudwatchevents_operations.R

cloudwatchevents_put_ruleR Documentation

Creates or updates the specified rule

Description

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/cloudwatchevents_put_rule/ for full documentation.

Usage

cloudwatchevents_put_rule(
  Name,
  ScheduleExpression = NULL,
  EventPattern = NULL,
  State = NULL,
  Description = NULL,
  RoleArn = NULL,
  Tags = NULL,
  EventBusName = NULL
)

Arguments

Name

[required] The name of the rule that you are creating or updating.

ScheduleExpression

The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

EventPattern

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

State

Indicates whether the rule is enabled or disabled.

Description

A description of the rule.

RoleArn

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.

Tags

The list of key-value pairs to associate with the rule.

EventBusName

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


paws.management documentation built on May 29, 2024, 1:50 a.m.