Skip to content

Rule

This class encapsulates and extends the ROS resource type ALIYUN::ALB::RuleALIYUN::Config::Rule is used to create a forwarding rule.

Initializers 

import com.aliyun.ros.cdk.alb.Rule;
Rule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .listenerId(java.lang.String)
    .listenerId(IResolvable)
    .priority(java.lang.Number)
    .priority(IResolvable)
    .ruleActions(IResolvable)
    .ruleActions(java.util.List<IResolvable)
    .ruleActions(RuleActionsProperty>)
    .ruleConditions(IResolvable)
    .ruleConditions(java.util.List<IResolvable)
    .ruleConditions(RuleConditionsProperty>)
    .ruleName(java.lang.String)
    .ruleName(IResolvable)
//  .direction(java.lang.String)
//  .direction(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.
listenerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property listenerId: The ID of the listener that is configured for the Application Load Balancer (ALB) instance.
priority java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property priority: The priority of the forwarding rule.
ruleActions com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRuleActionsProperty> Property ruleActions: The actions of the forwarding rule.
ruleConditions com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRuleConditionsProperty> Property ruleConditions: The conditions of the forwarding rule.
ruleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ruleName: The name of the forwarding rule.
direction java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property direction: Rule direction.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

listenerIdRequired

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

Property listenerId: The ID of the listener that is configured for the Application Load Balancer (ALB) instance.

priorityRequired

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

Property priority: The priority of the forwarding rule.

Valid values: 1 to 10000. A lower value specifies a higher priority. Note The priority of each forwarding rule within a listener must be unique.

ruleActionsRequired

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

Property ruleActions: The actions of the forwarding rule.

ruleConditionsRequired

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

Property ruleConditions: The conditions of the forwarding rule.

ruleNameRequired

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

Property ruleName: The name of the forwarding rule.

The name must be 2 to 128 characters in length. It can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

directionOptional

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

Property direction: Rule direction.

Valid values: Request or Response.

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.alb.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.
attrRuleId com.aliyun.ros.cdk.core.IResolvable Attribute RuleId: The ID of the forwarding rules.

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

attrRuleIdRequired 

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

Attribute RuleId: The ID of the forwarding rules.