software.amazon.awscdk.services.events

Class OnEventOptions.Builder

java.lang.Object

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

Enclosing interface:

OnEventOptions

public static final class OnEventOptions.Builder
extends Object

A builder for OnEventOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
OnEventOptions	build() Builds the configured instance.
OnEventOptions.Builder	withDescription(String value) Sets the value of Description
OnEventOptions.Builder	withEventPattern(EventPattern value) Sets the value of EventPattern
OnEventOptions.Builder	withRuleName(String value) Sets the value of RuleName
OnEventOptions.Builder	withTarget(IRuleTarget value) Sets the value of Target

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

withTarget

public OnEventOptions.Builder withTarget(IRuleTarget value)

Sets the value of Target

Parameters:

value - The target to register for the event.

Returns:

this

withDescription

public OnEventOptions.Builder withDescription(@Nullable
                                              String value)

Sets the value of Description

Parameters:

value - A description of the rule's purpose.

Returns:

this

withEventPattern

public OnEventOptions.Builder withEventPattern(@Nullable
                                               EventPattern value)

Sets the value of EventPattern

Parameters:

value - Additional restrictions for the event to route to the specified target.

Returns:

this

withRuleName

public OnEventOptions.Builder withRuleName(@Nullable
                                           String value)

Sets the value of RuleName

Parameters:

value - A name for the rule.

Returns:

this

build

public OnEventOptions build()

Builds the configured instance.

Returns:

a new instance of OnEventOptions

Throws:

NullPointerException - if any required attribute was not provided