software.amazon.awscdk.services.events

Interface OnEventOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

OnEventOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/0.11.2 (build 27d16c2)",
           date="2019-06-10T11:04:14.229Z")
 @Stability(value=Experimental)
public interface OnEventOptions
extends software.amazon.jsii.JsiiSerializable

Standard set of options for `onXxx` event handlers on construct. EXPERIMENTAL

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OnEventOptions.Builder A builder for OnEventOptions
static class	OnEventOptions.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
static OnEventOptions.Builder	builder()
String	getDescription() A description of the rule's purpose.
EventPattern	getEventPattern() Additional restrictions for the event to route to the specified target.
String	getRuleName() A name for the rule.
IRuleTarget	getTarget() The target to register for the event.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTarget

@Stability(value=Experimental)
IRuleTarget getTarget()

The target to register for the event. EXPERIMENTAL

getDescription

@Stability(value=Experimental)
String getDescription()

A description of the rule's purpose. EXPERIMENTAL

getEventPattern

@Stability(value=Experimental)
EventPattern getEventPattern()

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. EXPERIMENTAL

See Also:

http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CloudWatchEventsandEventPatterns.html

getRuleName

@Stability(value=Experimental)
String getRuleName()

A name for the rule. Default: AWS CloudFormation generates a unique physical ID. EXPERIMENTAL

builder

@Stability(value=Experimental)
static OnEventOptions.Builder builder()

Returns:

a OnEventOptions.Builder of OnEventOptions