class Aws::CloudWatchEvents::Types::PutRuleRequest
@note When making an API call, you may pass PutRuleRequest
data as a hash: { name: "RuleName", # required schedule_expression: "ScheduleExpression", event_pattern: "EventPattern", state: "ENABLED", # accepts ENABLED, DISABLED description: "RuleDescription", role_arn: "RoleArn", tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], event_bus_name: "EventBusNameOrArn", }
@!attribute [rw] name
The name of the rule that you are creating or updating. @return [String]
@!attribute [rw] schedule_expression
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)". @return [String]
@!attribute [rw] event_pattern
The event pattern. 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
Indicates whether the rule is enabled or disabled. @return [String]
@!attribute [rw] description
A description of the rule. @return [String]
@!attribute [rw] role_arn
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. @return [String]
@!attribute [rw] tags
The list of key-value pairs to associate with the rule. @return [Array<Types::Tag>]
@!attribute [rw] event_bus_name
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutRuleRequest AWS API Documentation
Constants
- SENSITIVE