software.amazon.awscdk.services.events

Class Rule

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.events.Rule

All Implemented Interfaces:

IConstruct, IDependable, IResource, IRule

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.446Z")
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 interface software.amazon.awscdk.services.events.IRule

IRule.Jsii$Default, IRule.Jsii$Proxy

Constructor Summary

Constructors

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

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

Methods inherited from class software.amazon.awscdk.core.Resource

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

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Rule

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

Rule

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

Rule

public Rule(software.constructs.Construct scope,
            java.lang.String id,
            RuleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Rule

public Rule(software.constructs.Construct scope,
            java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromEventRuleArn

public static IRule fromEventRuleArn(software.constructs.Construct scope,
                                     java.lang.String id,
                                     java.lang.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

public void addEventPattern(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

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(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

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.

validate

protected java.util.List<java.lang.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 Construct

Returns:

An array of validation error messages, or an empty array if the construct is valid.

getRuleArn

public java.lang.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

public java.lang.String getRuleName()

The name event rule.

Specified by:

getRuleName in interface IRule