Skip to content

PutRuleRequest

Source code in docs_src/capo_cloudwatch_events/types/put_rule_request.py
class PutRuleRequest(TypedDict, closed=True):
    name: "capo_cloudwatch_events.types.rule_name.RuleName"
    """<p>The name of the rule that you are creating or updating.</p>"""
    schedule_expression: NotRequired[
        "capo_cloudwatch_events.types.schedule_expression.ScheduleExpression"
    ]
    """<p>The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".</p>"""
    event_pattern: NotRequired[
        "capo_cloudwatch_events.types.event_pattern.EventPattern"
    ]
    """<p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""
    state: NotRequired["capo_cloudwatch_events.types.rule_state.RuleState"]
    """<p>Indicates whether the rule is enabled or disabled.</p>"""
    description: NotRequired[
        "capo_cloudwatch_events.types.rule_description.RuleDescription"
    ]
    """<p>A description of the rule.</p>"""
    role_arn: NotRequired["capo_cloudwatch_events.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p> <p>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 <code>RoleArn</code> with proper permissions in the <code>Target</code> structure, instead of here in this parameter.</p>"""
    tags: NotRequired["capo_cloudwatch_events.types.tag_list.TagList"]
    """<p>The list of key-value pairs to associate with the rule.</p>"""
    event_bus_name: NotRequired[
        "capo_cloudwatch_events.types.event_bus_name_or_arn.EventBusNameOrArn"
    ]
    """<p>The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.</p>"""

description instance-attribute

description: NotRequired[RuleDescription]

A description of the rule.

event_bus_name instance-attribute

event_bus_name: NotRequired[EventBusNameOrArn]

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

event_pattern instance-attribute

event_pattern: NotRequired[EventPattern]

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

name instance-attribute

name: RuleName

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

role_arn instance-attribute

role_arn: NotRequired[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.

schedule_expression instance-attribute

schedule_expression: NotRequired[ScheduleExpression]

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

state instance-attribute

state: NotRequired[RuleState]

Indicates whether the rule is enabled or disabled.

tags instance-attribute

tags: NotRequired[TagList]

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