GradientEdge CDK Utils
    Preparing search index...
    interface EventRuleProps {
        crossStackScope?: Construct;
        description?: string;
        enabled?: boolean;
        eventBus?: IEventBusRef;
        eventPattern?: EventPattern;
        role?: IRoleRef;
        ruleName?: string;
        schedule?: Schedule;
        tags?: TagProps[];
        targets?: IRuleTarget[];
    }

    Hierarchy

    • RuleProps
      • EventRuleProps
    Index

    Properties

    crossStackScope?: Construct

    The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This helps dealing with cycles that often arise in these situations.

    - none (the main scope will be used, even for cross-stack Events)
    
    description?: string

    A description of the rule's purpose.

    - No description
    
    enabled?: boolean

    Indicates whether the rule is enabled.

    true
    
    eventBus?: IEventBusRef

    The event bus to associate with this rule.

    - The default event bus.
    
    eventPattern?: EventPattern

    Additional restrictions for the event to route to the specified target

    The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.

    - No additional filtering based on an event pattern.
    
    role?: IRoleRef

    The role that is used for target invocation. Must be assumable by principal events.amazonaws.com.

    - No role associated
    
    ruleName?: string

    A name for the rule.

    AWS CloudFormation generates a unique physical ID.
    
    schedule?: Schedule

    The schedule or rate (frequency) that determines when EventBridge runs the rule.

    You must specify this property, the eventPattern property, or both.

    For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide.

    tags?: TagProps[]
    targets?: IRuleTarget[]

    Targets to invoke when this rule matches an event.

    Input will be the full matched event. If you wish to specify custom target input, use addTarget(target[, inputOptions]).

    - No targets.