software.amazon.awscdk.services.events

Class EventRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.services.events.EventRule

All Implemented Interfaces:

software.amazon.awscdk.IConstruct, software.amazon.awscdk.IDependable, IEventRule, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.7.15 (build e429c41)",
           date="2019-03-07T22:14:39.117Z")
public class EventRule
extends software.amazon.awscdk.Construct
implements IEventRule

Defines a CloudWatch Event Rule in this stack.

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

IEventRule.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	EventRule(software.amazon.awscdk.Construct scope, String id)
	EventRule(software.amazon.awscdk.Construct scope, String id, EventRuleProps props)
protected	EventRule(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(IEventRuleTarget target) Adds a target to the rule.
void	addTarget(IEventRuleTarget target, TargetInputTemplate inputOptions) Adds a target to the rule.
EventRuleImportProps	export() Exports this rule resource from this stack and returns an import token.
String	getRuleArn() The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
static IEventRule	import_(software.amazon.awscdk.Construct scope, String id, EventRuleImportProps props) Imports a rule by ARN into this stack.
protected List<String>	validate() Validate the current construct.

Methods inherited from class software.amazon.awscdk.Construct

getDependencyRoots, getNode, isConstruct, prepare, 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.awscdk.IDependable

getDependencyRoots

Constructor Detail

EventRule

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

EventRule

public EventRule(software.amazon.awscdk.Construct scope,
                 String id,
                 @Nullable
                 EventRuleProps props)

EventRule

public EventRule(software.amazon.awscdk.Construct scope,
                 String id)

Method Detail

import_

public static IEventRule import_(software.amazon.awscdk.Construct scope,
                                 String id,
                                 EventRuleImportProps props)

Imports a rule by ARN into this stack.

addEventPattern

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" ] } }

addEventPattern

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" ] } }

addTarget

public void addTarget(@Nullable
                      IEventRuleTarget target,
                      @Nullable
                      TargetInputTemplate inputOptions)

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

addTarget

public void addTarget(@Nullable
                      IEventRuleTarget target)

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

addTarget

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.

export

public EventRuleImportProps export()

Exports this rule resource from this stack and returns an import token.

Specified by:

export in interface IEventRule

validate

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.

Overrides:

validate in class software.amazon.awscdk.Construct

getRuleArn

public String getRuleArn()

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

Specified by:

getRuleArn in interface IEventRule