software.amazon.awscdk.services.events

Class EventRuleProps.Builder

java.lang.Object

software.amazon.awscdk.services.events.EventRuleProps.Builder

Enclosing interface:

EventRuleProps

public static final class EventRuleProps.Builder
extends Object

A builder for EventRuleProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EventRuleProps	build() Builds the configured instance.
EventRuleProps.Builder	withDescription(String value) Sets the value of Description
EventRuleProps.Builder	withEnabled(Boolean value) Sets the value of Enabled
EventRuleProps.Builder	withEventPattern(EventPattern value) Sets the value of EventPattern
EventRuleProps.Builder	withRuleName(String value) Sets the value of RuleName
EventRuleProps.Builder	withScheduleExpression(String value) Sets the value of ScheduleExpression
EventRuleProps.Builder	withTargets(List<IEventRuleTarget> value) Sets the value of Targets

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

withDescription

public EventRuleProps.Builder withDescription(@Nullable
                                              String value)

Sets the value of Description

Parameters:

value - A description of the rule's purpose.

Returns:

this

withEnabled

public EventRuleProps.Builder withEnabled(@Nullable
                                          Boolean value)

Sets the value of Enabled

Parameters:

value - Indicates whether the rule is enabled.

Returns:

this

withEventPattern

public EventRuleProps.Builder withEventPattern(@Nullable
                                               EventPattern value)

Sets the value of EventPattern

Parameters:

value - 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

withRuleName

public EventRuleProps.Builder withRuleName(@Nullable
                                           String value)

Sets the value of RuleName

Parameters:

value - A name for the rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

Returns:

this

withScheduleExpression

public EventRuleProps.Builder withScheduleExpression(@Nullable
                                                     String value)

Sets the value of ScheduleExpression

Parameters:

value - 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

withTargets

public EventRuleProps.Builder withTargets(@Nullable
                                          List<IEventRuleTarget> value)

Sets the value of Targets

Parameters:

value - 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

public EventRuleProps build()

Builds the configured instance.

Returns:

a new instance of EventRuleProps

Throws:

NullPointerException - if any required attribute was not provided