software.amazon.awscdk.services.events

Class Rule.Builder

java.lang.Object

software.amazon.awscdk.services.events.Rule.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Rule>

Enclosing class:

Rule

@Stability(value=Stable)
public static final class Rule.Builder
extends Object
implements software.amazon.jsii.Builder<Rule>

A fluent builder for Rule.

Method Summary

Modifier and Type	Method and Description
Rule	build()
static Rule.Builder	create(software.constructs.Construct scope, String id)
Rule.Builder	crossStackScope(software.constructs.Construct crossStackScope) The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
Rule.Builder	description(String description) A description of the rule's purpose.
Rule.Builder	enabled(Boolean enabled) Indicates whether the rule is enabled.
Rule.Builder	eventBus(IEventBus eventBus) The event bus to associate with this rule.
Rule.Builder	eventPattern(EventPattern eventPattern) Additional restrictions for the event to route to the specified target.
Rule.Builder	ruleName(String ruleName) A name for the rule.
Rule.Builder	schedule(Schedule schedule) The schedule or rate (frequency) that determines when EventBridge runs the rule.
Rule.Builder	targets(List<? extends IRuleTarget> targets) Targets to invoke when this rule matches an event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static Rule.Builder create(software.constructs.Construct scope,
                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Rule.Builder.

crossStackScope

@Stability(value=Stable)
public Rule.Builder crossStackScope(software.constructs.Construct crossStackScope)

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.

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

Parameters:

crossStackScope - The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region). This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public Rule.Builder description(String description)

A description of the rule's purpose.

Default: - No description

Parameters:

description - A description of the rule's purpose. This parameter is required.

Returns:

this

eventPattern

@Stability(value=Stable)
public Rule.Builder eventPattern(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.

Default: - No additional filtering based on an event pattern.

Parameters:

eventPattern - Additional restrictions for the event to route to the specified target. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html

ruleName

@Stability(value=Stable)
public Rule.Builder ruleName(String ruleName)

A name for the rule.

Default: AWS CloudFormation generates a unique physical ID.

Parameters:

ruleName - A name for the rule. This parameter is required.

Returns:

this

enabled

@Stability(value=Stable)
public Rule.Builder enabled(Boolean enabled)

Indicates whether the rule is enabled.

Default: true

Parameters:

enabled - Indicates whether the rule is enabled. This parameter is required.

Returns:

this

eventBus

@Stability(value=Stable)
public Rule.Builder eventBus(IEventBus eventBus)

The event bus to associate with this rule.

Default: - The default event bus.

Parameters:

eventBus - The event bus to associate with this rule. This parameter is required.

Returns:

this

schedule

@Stability(value=Stable)
public Rule.Builder schedule(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.

Default: - None.

Parameters:

schedule - The schedule or rate (frequency) that determines when EventBridge runs the rule. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html

targets

@Stability(value=Stable)
public Rule.Builder targets(List<? extends IRuleTarget> targets)

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]).

Default: - No targets.

Parameters:

targets - Targets to invoke when this rule matches an event. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public Rule build()

Specified by:

build in interface software.amazon.jsii.Builder<Rule>