IRule

• Extends: @alicloud/ros-cdk-core.IResource

• Implemented By: @alicloud/ros-cdk-slb.datasource.Rule, @alicloud/ros-cdk-slb.datasource.IRule

Represents a Rule.

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node for this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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.

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

attrCookie^Required

public readonly attrCookie: string | IResolvable;

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

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

attrCookieTimeout^Required

public readonly attrCookieTimeout: string | IResolvable;

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

Attribute CookieTimeout: The timeout period of a cookie.

attrDomain^Required

public readonly attrDomain: string | IResolvable;

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

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

attrHealthCheck^Required

public readonly attrHealthCheck: string | IResolvable;

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

Attribute HealthCheck: Specifies whether to enable health checks.

attrHealthCheckConnectPort^Required

public readonly attrHealthCheckConnectPort: string | IResolvable;

• Type: string | @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: string | IResolvable;

• Type: string | @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: string | IResolvable;

• Type: string | @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: string | IResolvable;

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

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

attrHealthCheckTimeout^Required

public readonly attrHealthCheckTimeout: string | IResolvable;

• Type: string | @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: string | IResolvable;

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

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

attrHealthyThreshold^Required

public readonly attrHealthyThreshold: string | IResolvable;

• Type: string | @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: string | IResolvable;

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

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

attrListenerSync^Required

public readonly attrListenerSync: string | IResolvable;

• Type: string | @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: string | IResolvable;

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

Attribute LoadBalancerId: The ID of the SLB instance.

attrRuleId^Required

public readonly attrRuleId: string | IResolvable;

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

Attribute RuleId: The ID of the forwarding rule.

attrRuleName^Required

public readonly attrRuleName: string | IResolvable;

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

Attribute RuleName: The name of the forwarding rule.

attrScheduler^Required

public readonly attrScheduler: string | IResolvable;

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

Attribute Scheduler: The scheduling algorithm.

attrStickySession^Required

public readonly attrStickySession: string | IResolvable;

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

Attribute StickySession: Indicates whether session persistence is enabled.

Valid values: on and off.

attrStickySessionType^Required

public readonly attrStickySessionType: string | IResolvable;

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

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

attrUnhealthyThreshold^Required

public readonly attrUnhealthyThreshold: string | IResolvable;

• Type: string | @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: string | IResolvable;

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

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

attrVserverGroupId^Required

public readonly attrVserverGroupId: string | IResolvable;

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

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

props^Required

public readonly props: RuleProps;

• Type: RuleProps