Skip to content

Rule

  • Implements: AlibabaCloud.SDK.ROS.CDK.Slb.datasource.IRule

This class encapsulates and extends the ROS resource type DATASOURCE::SLB::Rule, which is used to query the configuration details of a forwarding rule.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Slb;
new Rule(Construct Scope, string Id, RuleProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props RuleProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

IdRequired

  • Type: string

PropsRequired


EnableResourcePropertyConstraintOptional

  • Type: bool

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.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc No description.
GetAtt No description.
SetMetadata No description.

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.


AddCondition

private void AddCondition(RosCondition Condition)

ConditionRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency

private void AddDependency(Resource Resource)

ResourceRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

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

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Slb;
Rule.IsConstruct(object X);

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Env AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment The environment this resource belongs to.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrCookie object Attribute Cookie: The cookie to be configured on the backend server.
AttrCookieTimeout object Attribute CookieTimeout: The timeout period of a cookie.
AttrDomain object Attribute Domain: The domain name that is configured in the forwarding rule.
AttrHealthCheck object Attribute HealthCheck: Specifies whether to enable health checks.
AttrHealthCheckConnectPort object Attribute HealthCheckConnectPort: The port of the backend server that is used for health checks.
AttrHealthCheckDomain object Attribute HealthCheckDomain: The domain name that is used for health checks.
AttrHealthCheckHttpCode object Attribute HealthCheckHttpCode: The HTTP status code that indicates a successful health check.
AttrHealthCheckInterval object Attribute HealthCheckInterval: The time interval between two consecutive health checks.
AttrHealthCheckTimeout object Attribute HealthCheckTimeout: The timeout period of a health check response.
AttrHealthCheckUri object Attribute HealthCheckUri: The URI that is used for health checks.
AttrHealthyThreshold object Attribute HealthyThreshold: The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy.
AttrListenerPort object Attribute ListenerPort: The listener port that is used by the SLB instance.
AttrListenerSync object Attribute ListenerSync: Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.
AttrLoadBalancerId object Attribute LoadBalancerId: The ID of the SLB instance.
AttrRuleId object Attribute RuleId: The ID of the forwarding rule.
AttrRuleName object Attribute RuleName: The name of the forwarding rule.
AttrScheduler object Attribute Scheduler: The scheduling algorithm.
AttrStickySession object Attribute StickySession: Indicates whether session persistence is enabled.
AttrStickySessionType object Attribute StickySessionType: The method that is used to handle a cookie.
AttrUnhealthyThreshold object Attribute UnhealthyThreshold: The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy.
AttrUrl object Attribute Url: The URL that is configured in the forwarding rule.
AttrVserverGroupId object Attribute VserverGroupId: The ID of the vServer group that is associated with the forwarding rule.
Props RuleProps No description.

NodeRequired

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.


EnvRequired

public IResourceEnvironment Env { get; }
  • Type: AlibabaCloud.SDK.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.


RefRequired

public string Ref { get; }
  • Type: string

StackRequired

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.


ResourceOptional

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrCookieRequired

public object AttrCookie { get; }
  • Type: object

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


AttrCookieTimeoutRequired

public object AttrCookieTimeout { get; }
  • Type: object

Attribute CookieTimeout: The timeout period of a cookie.


AttrDomainRequired

public object AttrDomain { get; }
  • Type: object

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


AttrHealthCheckRequired

public object AttrHealthCheck { get; }
  • Type: object

Attribute HealthCheck: Specifies whether to enable health checks.


AttrHealthCheckConnectPortRequired

public object AttrHealthCheckConnectPort { get; }
  • Type: object

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

Valid values: 1 to 65535.


AttrHealthCheckDomainRequired

public object AttrHealthCheckDomain { get; }
  • Type: object

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 (-).


AttrHealthCheckHttpCodeRequired

public object AttrHealthCheckHttpCode { get; }
  • Type: object

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

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


AttrHealthCheckIntervalRequired

public object AttrHealthCheckInterval { get; }
  • Type: object

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


AttrHealthCheckTimeoutRequired

public object AttrHealthCheckTimeout { get; }
  • Type: object

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.


AttrHealthCheckUriRequired

public object AttrHealthCheckUri { get; }
  • Type: object

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


AttrHealthyThresholdRequired

public object AttrHealthyThreshold { get; }
  • Type: object

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.


AttrListenerPortRequired

public object AttrListenerPort { get; }
  • Type: object

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


AttrListenerSyncRequired

public object AttrListenerSync { get; }
  • Type: object

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


AttrLoadBalancerIdRequired

public object AttrLoadBalancerId { get; }
  • Type: object

Attribute LoadBalancerId: The ID of the SLB instance.


AttrRuleIdRequired

public object AttrRuleId { get; }
  • Type: object

Attribute RuleId: The ID of the forwarding rule.


AttrRuleNameRequired

public object AttrRuleName { get; }
  • Type: object

Attribute RuleName: The name of the forwarding rule.


AttrSchedulerRequired

public object AttrScheduler { get; }
  • Type: object

Attribute Scheduler: The scheduling algorithm.


AttrStickySessionRequired

public object AttrStickySession { get; }
  • Type: object

Attribute StickySession: Indicates whether session persistence is enabled.

Valid values: on and off.


AttrStickySessionTypeRequired

public object AttrStickySessionType { get; }
  • Type: object

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


AttrUnhealthyThresholdRequired

public object AttrUnhealthyThreshold { get; }
  • Type: object

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.


AttrUrlRequired

public object AttrUrl { get; }
  • Type: object

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


AttrVserverGroupIdRequired

public object AttrVserverGroupId { get; }
  • Type: object

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


PropsRequired

public RuleProps Props { get; }