Skip to content

Rule

This class encapsulates and extends the ROS resource type ALIYUN::EventBridge::Rule, which is used to create an event rule for an 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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
eventBusName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property eventBusName: The name of the event bus.
filterPattern com.aliyun.ros.cdk.core.IResolvable OR java.util.Map Property filterPattern: The event pattern, in the JSON format.
ruleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ruleName: The name of the event rule.
targets com.aliyun.ros.cdk.core.IResolvable OR java.util.ListTargetsProperty> Property targets: The event target to which events are delivered.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the event rule.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: The status of the event rule.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

eventBusNameRequired

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

Property eventBusName: The name of the event bus.

filterPatternRequired

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

Property filterPattern: The event pattern, in the JSON format.

ruleNameRequired

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

Property ruleName: The name of the event rule.

targetsRequired

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

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

descriptionOptional

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

Property description: The description of the event rule.

statusOptional

  • 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

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrEventBusName com.aliyun.ros.cdk.core.IResolvable Attribute EventBusName: The name of the event bus.
attrRuleArn com.aliyun.ros.cdk.core.IResolvable Attribute RuleARN: The Alibaba Cloud Resource Name (ARN) of the event rule.
attrRuleName com.aliyun.ros.cdk.core.IResolvable Attribute RuleName: The name of the event rule.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrEventBusNameRequired 

public IResolvable getAttrEventBusName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EventBusName: The name of the event bus.

attrRuleArnRequired 

public IResolvable getAttrRuleArn();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

The ARN is used for authorization.

attrRuleNameRequired 

public IResolvable getAttrRuleName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RuleName: The name of the event rule.

Structs