Rule

• Implements: IRule

This class encapsulates and extends the ROS resource type ALIYUN::ALB::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();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

listenerId^Required

• 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.

priority^Required

• 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.

ruleActions^Required

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

Property ruleActions: The actions of the forwarding rule.

ruleConditions^Required

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

Property ruleConditions: The conditions of the forwarding rule.

ruleName^Required

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

Property ruleName: The name of the forwarding rule.

• The length must be 2 to 128 English or Chinese characters.
• The name must start with a letter, a Chinese character, or a number, and can contain numbers, periods (.), underscores (_), hyphens (-), and spaces.

direction^Optional

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

Property direction: The direction in which the forwarding rule is applied.

Valid values:

• Request (default): The rule matches and processes requests sent from the client to the ALB instance.
• Response: The rule matches and processes responses returned from server groups to the ALB instance.

Basic ALB instances support only forwarding rules whose Direction is Request.

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.alb.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

attrListenerId^Required

public java.lang.Object getAttrListenerId();

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

Attribute ListenerId: The ID of the listener.

attrRuleId^Required

public java.lang.Object getAttrRuleId();

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

Attribute RuleId: The ID of the forwarding rules.

props^Required

public RuleProps getProps();

• Type: RuleProps