Skip to content

IRule

  • Extends: ros_cdk_core.IResource

  • Implemented By: ros_cdk_slb.datasource.Rule, ros_cdk_slb.datasource.IRule

Represents a Rule.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_cookie typing.Union[str, ros_cdk_core.IResolvable] Attribute Cookie: The cookie to be configured on the backend server.
attr_cookie_timeout typing.Union[str, ros_cdk_core.IResolvable] Attribute CookieTimeout: The timeout period of a cookie.
attr_domain typing.Union[str, ros_cdk_core.IResolvable] Attribute Domain: The domain name that is configured in the forwarding rule.
attr_health_check typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheck: Specifies whether to enable health checks.
attr_health_check_connect_port typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckConnectPort: The port of the backend server that is used for health checks.
attr_health_check_domain typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckDomain: The domain name that is used for health checks.
attr_health_check_http_code typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckHttpCode: The HTTP status code that indicates a successful health check.
attr_health_check_interval typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckInterval: The time interval between two consecutive health checks.
attr_health_check_timeout typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckTimeout: The timeout period of a health check response.
attr_health_check_uri typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthCheckUri: The URI that is used for health checks.
attr_healthy_threshold typing.Union[str, ros_cdk_core.IResolvable] Attribute HealthyThreshold: The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy.
attr_listener_port typing.Union[str, ros_cdk_core.IResolvable] Attribute ListenerPort: The listener port that is used by the SLB instance.
attr_listener_sync typing.Union[str, ros_cdk_core.IResolvable] Attribute ListenerSync: Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.
attr_load_balancer_id typing.Union[str, ros_cdk_core.IResolvable] Attribute LoadBalancerId: The ID of the SLB instance.
attr_rule_id typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleId: The ID of the forwarding rule.
attr_rule_name typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleName: The name of the forwarding rule.
attr_scheduler typing.Union[str, ros_cdk_core.IResolvable] Attribute Scheduler: The scheduling algorithm.
attr_sticky_session typing.Union[str, ros_cdk_core.IResolvable] Attribute StickySession: Indicates whether session persistence is enabled.
attr_sticky_session_type typing.Union[str, ros_cdk_core.IResolvable] Attribute StickySessionType: The method that is used to handle a cookie.
attr_unhealthy_threshold typing.Union[str, ros_cdk_core.IResolvable] Attribute UnhealthyThreshold: The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy.
attr_url typing.Union[str, ros_cdk_core.IResolvable] Attribute Url: The URL that is configured in the forwarding rule.
attr_vserver_group_id typing.Union[str, ros_cdk_core.IResolvable] Attribute VserverGroupId: The ID of the vServer group that is associated with the forwarding rule.
props RuleProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

env: IResourceEnvironment
  • Type: 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.


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


attr_cookieRequired

attr_cookie: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_cookie_timeout: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute CookieTimeout: The timeout period of a cookie.


attr_domainRequired

attr_domain: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_health_checkRequired

attr_health_check: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute HealthCheck: Specifies whether to enable health checks.


attr_health_check_connect_portRequired

attr_health_check_connect_port: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

Valid values: 1 to 65535.


attr_health_check_domainRequired

attr_health_check_domain: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 (-).


attr_health_check_http_codeRequired

attr_health_check_http_code: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


attr_health_check_intervalRequired

attr_health_check_interval: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_health_check_timeoutRequired

attr_health_check_timeout: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


attr_health_check_uriRequired

attr_health_check_uri: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_healthy_thresholdRequired

attr_healthy_threshold: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


attr_listener_portRequired

attr_listener_port: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_listener_syncRequired

attr_listener_sync: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_load_balancer_idRequired

attr_load_balancer_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute LoadBalancerId: The ID of the SLB instance.


attr_rule_idRequired

attr_rule_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleId: The ID of the forwarding rule.


attr_rule_nameRequired

attr_rule_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RuleName: The name of the forwarding rule.


attr_schedulerRequired

attr_scheduler: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Scheduler: The scheduling algorithm.


attr_sticky_sessionRequired

attr_sticky_session: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute StickySession: Indicates whether session persistence is enabled.

Valid values: on and off.


attr_sticky_session_typeRequired

attr_sticky_session_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_unhealthy_thresholdRequired

attr_unhealthy_threshold: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


attr_urlRequired

attr_url: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


attr_vserver_group_idRequired

attr_vserver_group_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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


propsRequired

props: RuleProps