Rule

• Implements: IRule

This class encapsulates and extends the ROS resource type ALIYUN::SLB::Rule.

Initializers

import com.aliyun.ros.cdk.slb.Rule;
Rule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .listenerPort(java.lang.Number)
    .listenerPort(IResolvable)
    .loadBalancerId(java.lang.String)
    .loadBalancerId(IResolvable)
    .ruleList(IResolvable)
    .ruleList(java.util.List<IResolvable)
    .ruleList(RuleListProperty>)
//  .listenerProtocol(java.lang.String)
//  .listenerProtocol(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

listenerPort^Required

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

Property listenerPort: The front-end HTTPS listener port of the Server Load Balancer instance.

Valid value: 1-65535

loadBalancerId^Required

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

Property loadBalancerId: The ID of Server Load Balancer instance.

ruleList^Required

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

Property ruleList: The forwarding rules to add.

You can add up to 10 forwarding rules in a single request. Each forwarding rule consists of the following parameters:

• RuleName (Required): String. The name of the forwarding rule. The name must be 1 to 40 characters in length and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_). Rule names must be unique within the same listener.
• Domain (Optional): String. The domain name to associate with the forwarding rule. You must specify at least one of this parameter and the Url parameter.
• Url (Optional): String. The URL path. The path must be 1 to 80 characters in length. It can contain Chinese characters, letters, digits, and the following special characters: - \/ . % ? # &. The URL path must start with a forward slash (/), but cannot be a single forward slash (/). You must specify at least one of this parameter and the Domain parameter.
• VServerGroupId (Required): String. The ID of the target vServer group for the forwarding rule.

You must specify the Domain parameter, the Url parameter, or both. The combination of a Domain and a Url must be unique within the same listener.

listenerProtocol^Optional

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

Property listenerProtocol: The frontend protocol of the listener.

This parameter is required if you configure listeners that use different protocols on the same port.

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

attrRules^Required

public java.lang.Object getAttrRules();

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

Attribute Rules: A list of forwarding rules.

Each element of rules contains "RuleId".

props^Required

public RuleProps getProps();

• Type: RuleProps