Class Rule

Defines a CloudWatch Event Rule in this stack.

Inheritance
System.Object
Construct
Resource
Rule
Inherited Members
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.AWS.Events.dll
Syntax (csharp)
public class Rule : Resource, IRule, IResource, IConstruct, IDependable
Syntax (vb)
Public Class Rule
    Inherits Resource
    Implements IRule, IResource, IConstruct, IDependable
Remarks

stability: Stable resource: AWS::Events::Rule

Synopsis

Constructors

Rule(Construct, String, IRuleProps)
Rule(ByRefValue)
Rule(DeputyBase.DeputyProps)

Properties

RuleArn

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

The name event rule.

Methods

AddEventPattern(IEventPattern)

Adds an event pattern filter to this rule.
AddTarget(IRuleTarget)

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.
FromEventRuleArn(Construct, String, String)
Validate()

Validate the current construct.

Constructors

Rule(Construct, String, IRuleProps)

public Rule(Construct scope, string id, IRuleProps props = null)
Parameters
scope Construct
id System.String
props IRuleProps
Remarks

stability: Stable

Rule(ByRefValue)

protected Rule(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

Rule(DeputyBase.DeputyProps)

protected Rule(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

Properties

RuleArn

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

public virtual string RuleArn { get; }
Property Value

System.String

Remarks

stability: Stable

RuleName

The name event rule.

public virtual string RuleName { get; }
Property Value

System.String

Remarks

stability: Stable

Methods

AddEventPattern(IEventPattern)

Adds an event pattern filter to this rule.

public virtual void AddEventPattern(IEventPattern eventPattern = null)
Parameters
eventPattern IEventPattern
Remarks

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" ] } } stability: Stable

AddTarget(IRuleTarget)

Adds a target to the rule. The abstract class RuleTarget can be extended to define new targets.

public virtual void AddTarget(IRuleTarget target = null)
Parameters
target IRuleTarget
Remarks

No-op if target is undefined. stability: Stable

FromEventRuleArn(Construct, String, String)

public static IRule FromEventRuleArn(Construct scope, string id, string eventRuleArn)
Parameters
scope Construct
id System.String
eventRuleArn System.String
Returns

IRule

Remarks

stability: Stable

Validate()

Validate the current construct.

protected override string[] Validate()
Returns

System.String[]

Overrides
Remarks

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis. stability: Stable

Implements