Rule

• Implements: IRule

This class encapsulates and extends the ROS resource type ALIYUN::EventBridge::Rule, which creates an event rule for a specified event bus.

Initializers

import com.aliyun.ros.cdk.eventbridge.Rule;
Rule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .eventBusName(java.lang.String)
    .eventBusName(IResolvable)
    .filterPattern(IResolvable)
    .filterPattern(java.util.Map<java.lang.String, java.lang.Object>)
    .ruleName(java.lang.String)
    .ruleName(IResolvable)
    .targets(IResolvable)
    .targets(java.util.List<IResolvable)
    .targets(TargetsProperty>)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .status(java.lang.String)
//  .status(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

eventBusName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property eventBusName: The name of the event bus.

filterPattern^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property filterPattern: The event pattern, in JSON format.

Supported pattern types are stringEqual and stringExpression. Each field can contain a maximum of five expressions in a map structure.

ruleName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ruleName: The name of the event rule.

targets^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTargetsProperty>

Property targets: The event target to which events are delivered.

description^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the event rule.

status^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property status: The status of the event rule.

Valid values: ENABLE: The event rule is enabled. It is the default state of the event rule. DISABLE: The event rule is disabled.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.eventbridge.Rule;
Rule.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrEventBusName^Required

public java.lang.Object getAttrEventBusName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EventBusName: The name of the event bus.

attrRuleArn^Required

public java.lang.Object getAttrRuleArn();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RuleARN: The Alibaba Cloud Resource Name (ARN) of the event rule.

The ARN is used for authorization.

attrRuleName^Required

public java.lang.Object getAttrRuleName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RuleName: The name of the event rule.

props^Required

public RuleProps getProps();

• Type: RuleProps

Structs