Package software.amazon.awscdk.services.events

Class OnEventOptions.Builder

java.lang.Object

software.amazon.awscdk.services.events.OnEventOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<OnEventOptions>

Enclosing interface:

OnEventOptions

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

A builder for OnEventOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OnEventOptions	build()	Builds the configured instance.
OnEventOptions.Builder	crossStackScope(software.constructs.Construct crossStackScope)	Sets the value of EventCommonOptions.getCrossStackScope()
OnEventOptions.Builder	description(String description)	Sets the value of EventCommonOptions.getDescription()
OnEventOptions.Builder	eventPattern(EventPattern eventPattern)	Sets the value of EventCommonOptions.getEventPattern()
OnEventOptions.Builder	ruleName(String ruleName)	Sets the value of EventCommonOptions.getRuleName()
OnEventOptions.Builder	target(IRuleTarget target)	Sets the value of OnEventOptions.getTarget()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

target

@Stability(Stable)
public OnEventOptions.Builder target(IRuleTarget target)

Sets the value of OnEventOptions.getTarget()

Parameters:

target - The target to register for the event.

Returns:

this

crossStackScope

@Stability(Stable)
public OnEventOptions.Builder crossStackScope(software.constructs.Construct crossStackScope)

Sets the value of EventCommonOptions.getCrossStackScope()

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 helps dealing with cycles that often arise in these situations.

Returns:

this

description

@Stability(Stable)
public OnEventOptions.Builder description(String description)

Sets the value of EventCommonOptions.getDescription()

Parameters:

description - A description of the rule's purpose.

Returns:

this

eventPattern

@Stability(Stable)
public OnEventOptions.Builder eventPattern(EventPattern eventPattern)

Sets the value of EventCommonOptions.getEventPattern()

Parameters:

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.

Returns:

this

ruleName

@Stability(Stable)
public OnEventOptions.Builder ruleName(String ruleName)

Sets the value of EventCommonOptions.getRuleName()

Parameters:

ruleName - A name for the rule.

Returns:

this

build

@Stability(Stable)
public OnEventOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of OnEventOptions

Throws:

NullPointerException - if any required attribute was not provided