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 fluent builder class for EventRuleProps.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
EventRuleProps	build()
EventRuleProps.Builder	withDescription(String value) A description of the rule's purpose.
EventRuleProps.Builder	withEnabled(Boolean value) Indicates whether the rule is enabled.
EventRuleProps.Builder	withEventPattern(EventPattern value) Describes which events CloudWatch Events routes to the specified target.
EventRuleProps.Builder	withRuleName(String value) A name for the rule.
EventRuleProps.Builder	withScheduleExpression(String value) The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.
EventRuleProps.Builder	withTargets(List<IEventRuleTarget> value) Targets to invoke when this rule matches an event.

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(String value)

A description of the rule's purpose.

withRuleName

public EventRuleProps.Builder withRuleName(String 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.

withEnabled

public EventRuleProps.Builder withEnabled(Boolean value)

Indicates whether the rule is enabled.

withScheduleExpression

public EventRuleProps.Builder withScheduleExpression(String 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.

See Also:

You must specify this property, the `eventPattern` property, or both.

withEventPattern

public EventRuleProps.Builder withEventPattern(EventPattern 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.

See Also:

You must specify this property (either via props or via `addEventPattern`), the `scheduleExpression` property, or both. The method `addEventPattern` can be used to add filter values to the event pattern.

withTargets

public EventRuleProps.Builder withTargets(List<IEventRuleTarget> 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])`.

build

public EventRuleProps build()