software.amazon.awscdk.services.events

Interface RuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RuleProps.Jsii$Proxy

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

EXPERIMENTAL

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RuleProps.Builder	builder()
String	getDescription() A description of the rule's purpose.
Boolean	getEnabled() Indicates whether the rule is enabled.
EventPattern	getEventPattern() Describes which events CloudWatch Events routes to the specified target.
String	getRuleName() A name for the rule.
String	getScheduleExpression() The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.
List<IRuleTarget>	getTargets() Targets to invoke when this rule matches an event.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

@Stability(value=Experimental)
String getDescription()

A description of the rule's purpose. Default: - No description. EXPERIMENTAL

getEnabled

@Stability(value=Experimental)
Boolean getEnabled()

Indicates whether the rule is enabled. Default: true EXPERIMENTAL

getEventPattern

@Stability(value=Experimental)
EventPattern getEventPattern()

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. Default: - None. EXPERIMENTAL

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.

getRuleName

@Stability(value=Experimental)
String getRuleName()

A name for the rule. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type. EXPERIMENTAL

getScheduleExpression

@Stability(value=Experimental)
String getScheduleExpression()

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. Default: - None. EXPERIMENTAL

See Also:

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

getTargets

@Stability(value=Experimental)
List<IRuleTarget> getTargets()

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])`. Default: - No targets. EXPERIMENTAL

builder

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

Returns:

a RuleProps.Builder of RuleProps