software.amazon.awscdk.services.events

Class EventRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Construct

software.amazon.awscdk.services.events.EventRuleRef

software.amazon.awscdk.services.events.EventRule

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

public class EventRule
extends EventRuleRef

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	EventRule(software.amazon.awscdk.Construct parent, String name)
	EventRule(software.amazon.awscdk.Construct parent, String name, 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.
RuleArn	getRuleArn() The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
List<String>	validate() This method can be implemented by derived constructs in order to perform validation logic.

Methods inherited from class software.amazon.awscdk.services.events.EventRuleRef

export, import_

Methods inherited from class software.amazon.awscdk.Construct

addChild, addError, addInfo, addMetadata, addMetadata, addWarning, ancestors, ancestors, findChild, getChildren, getContext, getId, getMetadata, getParent, getPath, getUniqueId, lock, requireContext, required, setContext, toString, toTreeString, toTreeString, tryFindChild, unlock, validateTree

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

Constructor Detail

EventRule

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

EventRule

public EventRule(software.amazon.awscdk.Construct parent,
                 String name,
                 @Nullable
                 EventRuleProps props)

EventRule

public EventRule(software.amazon.awscdk.Construct parent,
                 String name)

Method Detail

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.

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

validate

public List<String> validate()

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 RuleArn getRuleArn()

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

Overrides:

getRuleArn in class EventRuleRef