software.amazon.awscdk.services.events

Class Rule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.events.Rule

All Implemented Interfaces:

software.amazon.awscdk.IConstruct, software.amazon.awscdk.IDependable, software.amazon.awscdk.IResource, IRule, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.11.2 (build 27d16c2)",
           date="2019-06-10T11:04:14.230Z")
 @Stability(value=Experimental)
public class Rule
extends software.amazon.awscdk.Resource
implements IRule

Defines a CloudWatch Event Rule in this stack. EXPERIMENTAL

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.IRule

IRule.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Rule(software.amazon.awscdk.Construct scope, String id) EXPERIMENTAL
	Rule(software.amazon.awscdk.Construct scope, String id, RuleProps props) EXPERIMENTAL
protected	Rule(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
void	addEventPattern() Adds an event pattern filter to this rule.
void	addEventPattern(EventPattern eventPattern) Adds an event pattern filter to this rule.
void	addTarget() Adds a target to the rule.
void	addTarget(IRuleTarget target) Adds a target to the rule.
static IRule	fromEventRuleArn(software.amazon.awscdk.Construct scope, String id, String eventRuleArn) EXPERIMENTAL
String	getRuleArn() The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
protected List<String>	validate() Validate the current construct.

Methods inherited from class software.amazon.awscdk.Construct

getNode, isConstruct, prepare, synthesize, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Rule

protected Rule(software.amazon.jsii.JsiiObject.InitializationMode mode)

Rule

@Stability(value=Experimental)
public Rule(software.amazon.awscdk.Construct scope,
                                           String id,
                                           @Nullable
                                           RuleProps props)

EXPERIMENTAL

Rule

@Stability(value=Experimental)
public Rule(software.amazon.awscdk.Construct scope,
                                           String id)

EXPERIMENTAL

Method Detail

fromEventRuleArn

@Stability(value=Experimental)
public static IRule fromEventRuleArn(software.amazon.awscdk.Construct scope,
                                                                    String id,
                                                                    String eventRuleArn)

EXPERIMENTAL

addEventPattern

@Stability(value=Experimental)
public void addEventPattern(@Nullable
                                                           EventPattern eventPattern)

Adds an event pattern filter to this rule. If a pattern was already specified, these values are merged into the existing pattern. For example, if the rule already contains the pattern: { "resources": [ "r1" ], "detail": { "hello": [ 1 ] } } And `addEventPattern` is called with the pattern: { "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } } The resulting event pattern will be: { "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } } EXPERIMENTAL

addEventPattern

@Stability(value=Experimental)
public void addEventPattern()

Adds an event pattern filter to this rule. If a pattern was already specified, these values are merged into the existing pattern. For example, if the rule already contains the pattern: { "resources": [ "r1" ], "detail": { "hello": [ 1 ] } } And `addEventPattern` is called with the pattern: { "resources": [ "r2" ], "detail": { "foo": [ "bar" ] } } The resulting event pattern will be: { "resources": [ "r1", "r2" ], "detail": { "hello": [ 1 ], "foo": [ "bar" ] } } EXPERIMENTAL

addTarget

@Stability(value=Experimental)
public void addTarget(@Nullable
                                                     IRuleTarget target)

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets. No-op if target is undefined. EXPERIMENTAL

addTarget

@Stability(value=Experimental)
public void addTarget()

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets. No-op if target is undefined. EXPERIMENTAL

validate

@Stability(value=Experimental)
protected List<String> validate()

Validate the current construct. This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis. EXPERIMENTAL

Overrides:

validate in class software.amazon.awscdk.Construct

getRuleArn

@Stability(value=Experimental)
public String getRuleArn()

The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example. EXPERIMENTAL

Specified by:

getRuleArn in interface IRule