software.amazon.awscdk.services.events

Class Rule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.events.Rule

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.310Z")
 @Stability(value=Stable)
public class Rule
extends Resource
implements IRule

Defines an EventBridge Rule in this stack.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Function fn = Function.Builder.create(this, "MyFunc")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(Code.fromInline("exports.handler = handler.toString()"))
         .build();
 Rule rule = Rule.Builder.create(this, "rule")
         .eventPattern(EventPattern.builder()
                 .source(List.of("aws.ec2"))
                 .build())
         .build();
 Queue queue = new Queue(this, "Queue");
 rule.addTarget(LambdaFunction.Builder.create(fn)
         .deadLetterQueue(queue) // Optional: add a dead letter queue
         .maxEventAge(Duration.hours(2)) // Optional: set the maxEventAge retry policy
         .retryAttempts(2)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Rule.Builder A fluent builder for Rule.

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$Default, IRule.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Rule(software.constructs.Construct scope, String id)
	Rule(software.constructs.Construct scope, String id, RuleProps props)
protected	Rule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Rule(software.amazon.jsii.JsiiObjectRef objRef)

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.constructs.Construct scope, String id, String eventRuleArn) Import an existing EventBridge Rule provided an ARN.
String	getRuleArn() The value of the event rule Amazon Resource Name (ARN), such as arn:aws:events:us-east-2:123456789012:rule/example.
String	getRuleName() The name event rule.
protected List<String>	validateRule()

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, 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.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Rule

protected Rule(software.amazon.jsii.JsiiObjectRef objRef)

Rule

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

Rule

@Stability(value=Stable)
public Rule(@NotNull
                                     software.constructs.Construct scope,
                                     @NotNull
                                     String id,
                                     @Nullable
                                     RuleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Rule

@Stability(value=Stable)
public Rule(@NotNull
                                     software.constructs.Construct scope,
                                     @NotNull
                                     String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromEventRuleArn

@Stability(value=Stable)
 @NotNull
public static IRule fromEventRuleArn(@NotNull
                                                                        software.constructs.Construct scope,
                                                                        @NotNull
                                                                        String id,
                                                                        @NotNull
                                                                        String eventRuleArn)

Import an existing EventBridge Rule provided an ARN.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

eventRuleArn - Event Rule ARN (i.e. arn:aws:events:::rule/MyScheduledRule). This parameter is required.

addEventPattern

@Stability(value=Stable)
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" ]
   }
 }
 

Parameters:

eventPattern -

addEventPattern

@Stability(value=Stable)
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

@Stability(value=Stable)
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.

Parameters:

target -

addTarget

@Stability(value=Stable)
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.

validateRule

@Stability(value=Stable)
 @NotNull
protected List<String> validateRule()

getRuleArn

@Stability(value=Stable)
 @NotNull
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 IRule

getRuleName

@Stability(value=Stable)
 @NotNull
public String getRuleName()

The name event rule.

Specified by:

getRuleName in interface IRule