software.amazon.awscdk.services.events

Class Rule.Builder

java.lang.Object

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

Enclosing class:

Rule

public static final class Rule.Builder
extends java.lang.Object

A fluent builder for Rule.

Method Summary

Modifier and Type	Method and Description
Rule	build()
static Rule.Builder	create(software.constructs.Construct scope, java.lang.String id)
Rule.Builder	description(java.lang.String description) A description of the rule's purpose.
Rule.Builder	enabled(java.lang.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) Describes which events EventBridge routes to the specified target.
Rule.Builder	ruleName(java.lang.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(java.util.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

public static Rule.Builder create(software.constructs.Construct scope,
                                  java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Rule.Builder.

description

public Rule.Builder description(java.lang.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

enabled

public Rule.Builder enabled(java.lang.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

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

eventPattern

public Rule.Builder eventPattern(EventPattern eventPattern)

Describes which events EventBridge routes to the specified target.

These routed events are matched events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Default: - None.

Parameters:

eventPattern - Describes which events EventBridge routes to the specified target. This parameter is required.

Returns:

this

See Also:

You must specify this property (either via props or via `addEventPattern`), the `scheduleExpression` property, or both. The method `addEventPattern` can be used to add filter values to the event pattern.

ruleName

public Rule.Builder ruleName(java.lang.String ruleName)

A name for the rule.

Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

Parameters:

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

Returns:

this

schedule

public Rule.Builder schedule(Schedule schedule)

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

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:

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

targets

public Rule.Builder targets(java.util.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

public Rule build()