software.amazon.awscdk.services.events

Class RuleProps.Builder

java.lang.Object

software.amazon.awscdk.services.events.RuleProps.Builder

Enclosing interface:

RuleProps

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

A builder for RuleProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RuleProps	build() Builds the configured instance.
RuleProps.Builder	description(String description) Sets the value of RuleProps.getDescription()
RuleProps.Builder	enabled(Boolean enabled) Sets the value of RuleProps.getEnabled()
RuleProps.Builder	eventBus(IEventBus eventBus) Sets the value of RuleProps.getEventBus()
RuleProps.Builder	eventPattern(EventPattern eventPattern) Sets the value of RuleProps.getEventPattern()
RuleProps.Builder	ruleName(String ruleName) Sets the value of RuleProps.getRuleName()
RuleProps.Builder	schedule(Schedule schedule) Sets the value of RuleProps.getSchedule()
RuleProps.Builder	targets(List<IRuleTarget> targets) Sets the value of RuleProps.getTargets()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

description

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

Sets the value of RuleProps.getDescription()

Parameters:

description - A description of the rule's purpose.

Returns:

this

enabled

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

Sets the value of RuleProps.getEnabled()

Parameters:

enabled - Indicates whether the rule is enabled.

Returns:

this

eventBus

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

Sets the value of RuleProps.getEventBus()

Parameters:

eventBus - The event bus to associate with this rule.

Returns:

this

eventPattern

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

Sets the value of RuleProps.getEventPattern()

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.

Returns:

this

ruleName

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

Sets the value of RuleProps.getRuleName()

Parameters:

ruleName - A name for the rule.

Returns:

this

schedule

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

Sets the value of RuleProps.getSchedule()

Parameters:

schedule - The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide.

Returns:

this

targets

@Stability(value=Stable)
public RuleProps.Builder targets(List<IRuleTarget> targets)

Sets the value of RuleProps.getTargets()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Returns:

a new instance of RuleProps

Throws:

NullPointerException - if any required attribute was not provided