software.amazon.awscdk.services.events

Class RuleProps.Builder

java.lang.Object

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

Enclosing interface:

RuleProps

@Stability(value=Experimental)
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	withDescription(String value) Sets the value of Description
RuleProps.Builder	withEnabled(Boolean value) Sets the value of Enabled
RuleProps.Builder	withEventPattern(EventPattern value) Sets the value of EventPattern
RuleProps.Builder	withRuleName(String value) Sets the value of RuleName
RuleProps.Builder	withScheduleExpression(String value) Sets the value of ScheduleExpression
RuleProps.Builder	withTargets(List<IRuleTarget> 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

@Stability(value=Experimental)
public RuleProps.Builder withDescription(@Nullable
                                                                        String value)

Sets the value of Description

Parameters:

value - A description of the rule's purpose.

Returns:

this

withEnabled

@Stability(value=Experimental)
public RuleProps.Builder withEnabled(@Nullable
                                                                    Boolean value)

Sets the value of Enabled

Parameters:

value - Indicates whether the rule is enabled.

Returns:

this

withEventPattern

@Stability(value=Experimental)
public RuleProps.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

@Stability(value=Experimental)
public RuleProps.Builder withRuleName(@Nullable
                                                                     String value)

Sets the value of RuleName

Parameters:

value - A name for the rule.

Returns:

this

withScheduleExpression

@Stability(value=Experimental)
public RuleProps.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.

Returns:

this

withTargets

@Stability(value=Experimental)
public RuleProps.Builder withTargets(@Nullable
                                                                    List<IRuleTarget> value)

Sets the value of Targets

Parameters:

value - Targets to invoke when this rule matches an event.

Returns:

this

build

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

Builds the configured instance.

Returns:

a new instance of RuleProps

Throws:

NullPointerException - if any required attribute was not provided