Rule

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

Initializers

import { datasource } from '@alicloud/ros-cdk-slb'
new datasource.Rule(scope: Construct, id: string, props: RuleProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	RuleProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: RuleProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

import { datasource } from '@alicloud/ros-cdk-slb'
datasource.Rule.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrCookie	@alicloud/ros-cdk-core.IResolvable	Attribute Cookie: The cookie to be configured on the backend server.
attrCookieTimeout	@alicloud/ros-cdk-core.IResolvable	Attribute CookieTimeout: The timeout period of a cookie.
attrDomain	@alicloud/ros-cdk-core.IResolvable	Attribute Domain: The domain name that is configured in the forwarding rule.
attrHealthCheck	@alicloud/ros-cdk-core.IResolvable	Attribute HealthCheck: Specifies whether to enable health checks.
attrHealthCheckConnectPort	@alicloud/ros-cdk-core.IResolvable	Attribute HealthCheckConnectPort: The port of the backend server that is used for health checks.
attrHealthCheckDomain	@alicloud/ros-cdk-core.IResolvable	Attribute HealthCheckDomain: The domain name that is used for health checks.
attrHealthCheckHttpCode	@alicloud/ros-cdk-core.IResolvable	Attribute HealthCheckHttpCode: The HTTP status code that indicates a successful health check.
attrHealthCheckInterval	@alicloud/ros-cdk-core.IResolvable	Attribute HealthCheckInterval: The time interval between two consecutive health checks.
attrHealthCheckTimeout	@alicloud/ros-cdk-core.IResolvable	Attribute HealthCheckTimeout: The timeout period of a health check response.
attrHealthCheckUri	@alicloud/ros-cdk-core.IResolvable	Attribute HealthCheckUri: The URI that is used for health checks.
attrHealthyThreshold	@alicloud/ros-cdk-core.IResolvable	Attribute HealthyThreshold: The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy.
attrListenerPort	@alicloud/ros-cdk-core.IResolvable	Attribute ListenerPort: The listener port that is used by the SLB instance.
attrListenerSync	@alicloud/ros-cdk-core.IResolvable	Attribute ListenerSync: Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.
attrLoadBalancerId	@alicloud/ros-cdk-core.IResolvable	Attribute LoadBalancerId: The ID of the SLB instance.
attrRuleId	@alicloud/ros-cdk-core.IResolvable	Attribute RuleId: The ID of the forwarding rule.
attrRuleName	@alicloud/ros-cdk-core.IResolvable	Attribute RuleName: The name of the forwarding rule.
attrScheduler	@alicloud/ros-cdk-core.IResolvable	Attribute Scheduler: The scheduling algorithm.
attrStickySession	@alicloud/ros-cdk-core.IResolvable	Attribute StickySession: Indicates whether session persistence is enabled.
attrStickySessionType	@alicloud/ros-cdk-core.IResolvable	Attribute StickySessionType: The method that is used to handle a cookie.
attrUnhealthyThreshold	@alicloud/ros-cdk-core.IResolvable	Attribute UnhealthyThreshold: The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy.
attrUrl	@alicloud/ros-cdk-core.IResolvable	Attribute Url: The URL that is configured in the forwarding rule.
attrVserverGroupId	@alicloud/ros-cdk-core.IResolvable	Attribute VserverGroupId: The ID of the vServer group that is associated with the forwarding rule.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrCookie^Required

public readonly attrCookie: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Cookie: The cookie to be configured on the backend server.

---

attrCookieTimeout^Required

public readonly attrCookieTimeout: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute CookieTimeout: The timeout period of a cookie.

---

attrDomain^Required

public readonly attrDomain: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Domain: The domain name that is configured in the forwarding rule.

---

attrHealthCheck^Required

public readonly attrHealthCheck: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheck: Specifies whether to enable health checks.

---

attrHealthCheckConnectPort^Required

public readonly attrHealthCheckConnectPort: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckConnectPort: The port of the backend server that is used for health checks.

Valid values: 1 to 65535.

---

attrHealthCheckDomain^Required

public readonly attrHealthCheckDomain: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckDomain: The domain name that is used for health checks.

Valid values: $_ip: The private IP address of the backend server. If the $_ip parameter is set or the HealthCheckDomain parameter is not set, SLB uses the private IP addresses of backend servers as the domain names for health checks. domain: The domain name must be 1 to 80 characters in length. It can contain only letters, digits, periods (.),and hyphens (-).

---

attrHealthCheckHttpCode^Required

public readonly attrHealthCheckHttpCode: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckHttpCode: The HTTP status code that indicates a successful health check.

Separate multiple HTTP status codes with commas (,). Default value: http_2xx.

---

attrHealthCheckInterval^Required

public readonly attrHealthCheckInterval: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckInterval: The time interval between two consecutive health checks.

---

attrHealthCheckTimeout^Required

public readonly attrHealthCheckTimeout: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckTimeout: The timeout period of a health check response.

If a backend ECS instance does not send an expected response within the specified period of time, the ECS instance is considered unhealthy.

---

attrHealthCheckUri^Required

public readonly attrHealthCheckUri: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthCheckUri: The URI that is used for health checks.

---

attrHealthyThreshold^Required

public readonly attrHealthyThreshold: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute HealthyThreshold: The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy.

In this case, the health check state is changed from fail to success.

---

attrListenerPort^Required

public readonly attrListenerPort: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ListenerPort: The listener port that is used by the SLB instance.

---

attrListenerSync^Required

public readonly attrListenerSync: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ListenerSync: Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.

---

attrLoadBalancerId^Required

public readonly attrLoadBalancerId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute LoadBalancerId: The ID of the SLB instance.

---

attrRuleId^Required

public readonly attrRuleId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute RuleId: The ID of the forwarding rule.

---

attrRuleName^Required

public readonly attrRuleName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute RuleName: The name of the forwarding rule.

---

attrScheduler^Required

public readonly attrScheduler: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Scheduler: The scheduling algorithm.

---

attrStickySession^Required

public readonly attrStickySession: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute StickySession: Indicates whether session persistence is enabled.

Valid values: on and off.

---

attrStickySessionType^Required

public readonly attrStickySessionType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute StickySessionType: The method that is used to handle a cookie.

---

attrUnhealthyThreshold^Required

public readonly attrUnhealthyThreshold: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute UnhealthyThreshold: The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy.

In this case, the health check state is changed from success to fail.

---

attrUrl^Required

public readonly attrUrl: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Url: The URL that is configured in the forwarding rule.

---

attrVserverGroupId^Required

public readonly attrVserverGroupId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute VserverGroupId: The ID of the vServer group that is associated with the forwarding rule.

---