software.amazon.awscdk.services.events

Class Rule.Builder

java.lang.Object

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

Enclosing class:

Rule

@Stability(value=Stable)
public static final class Rule.Builder
extends Object

A fluent builder for Rule.

Method Summary

Modifier and Type	Method and Description
Rule	build()
static Rule.Builder	create(Construct scope, String id)
Rule.Builder	description(String description)
Rule.Builder	enabled(Boolean enabled)
Rule.Builder	eventBus(IEventBus eventBus)
Rule.Builder	eventPattern(EventPattern eventPattern)
Rule.Builder	ruleName(String ruleName)
Rule.Builder	schedule(Schedule schedule)
Rule.Builder	targets(List<IRuleTarget> targets)

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(Construct scope,
                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Rule.Builder.

description

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

Parameters:

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

Returns:

this

enabled

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

Parameters:

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

Returns:

this

eventBus

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

Parameters:

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

Returns:

this

eventPattern

@Stability(value=Stable)
public Rule.Builder eventPattern(EventPattern eventPattern)

Parameters:

eventPattern - Describes which events CloudWatch Events routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon CloudWatch User Guide. This parameter is required.

Returns:

this

ruleName

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

Parameters:

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

Returns:

this

schedule

@Stability(value=Stable)
public Rule.Builder schedule(Schedule schedule)

Parameters:

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

Returns:

this

targets

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