Rule

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

Initializers

from ros_cdk_slb import datasource
datasource.Rule(
  scope: Construct,
  id: str,
  rule_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
rule_id	typing.Union[str, ros_cdk_core.IResolvable]	Property ruleId: The ID of the forwarding rule.
refresh_options	typing.Union[str, ros_cdk_core.IResolvable]	Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

rule_id^Required

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

Property ruleId: The ID of the forwarding rule.

---

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

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

---

is_construct

from ros_cdk_slb import datasource
datasource.Rule.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_cookie	ros_cdk_core.IResolvable	Attribute Cookie: The cookie to be configured on the backend server.
attr_cookie_timeout	ros_cdk_core.IResolvable	Attribute CookieTimeout: The timeout period of a cookie.
attr_domain	ros_cdk_core.IResolvable	Attribute Domain: The domain name that is configured in the forwarding rule.
attr_health_check	ros_cdk_core.IResolvable	Attribute HealthCheck: Specifies whether to enable health checks.
attr_health_check_connect_port	ros_cdk_core.IResolvable	Attribute HealthCheckConnectPort: The port of the backend server that is used for health checks.
attr_health_check_domain	ros_cdk_core.IResolvable	Attribute HealthCheckDomain: The domain name that is used for health checks.
attr_health_check_http_code	ros_cdk_core.IResolvable	Attribute HealthCheckHttpCode: The HTTP status code that indicates a successful health check.
attr_health_check_interval	ros_cdk_core.IResolvable	Attribute HealthCheckInterval: The time interval between two consecutive health checks.
attr_health_check_timeout	ros_cdk_core.IResolvable	Attribute HealthCheckTimeout: The timeout period of a health check response.
attr_health_check_uri	ros_cdk_core.IResolvable	Attribute HealthCheckUri: The URI that is used for health checks.
attr_healthy_threshold	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	ros_cdk_core.IResolvable	Attribute ListenerPort: The listener port that is used by the SLB instance.
attr_listener_sync	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	ros_cdk_core.IResolvable	Attribute LoadBalancerId: The ID of the SLB instance.
attr_rule_id	ros_cdk_core.IResolvable	Attribute RuleId: The ID of the forwarding rule.
attr_rule_name	ros_cdk_core.IResolvable	Attribute RuleName: The name of the forwarding rule.
attr_scheduler	ros_cdk_core.IResolvable	Attribute Scheduler: The scheduling algorithm.
attr_sticky_session	ros_cdk_core.IResolvable	Attribute StickySession: Indicates whether session persistence is enabled.
attr_sticky_session_type	ros_cdk_core.IResolvable	Attribute StickySessionType: The method that is used to handle a cookie.
attr_unhealthy_threshold	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	ros_cdk_core.IResolvable	Attribute Url: The URL that is configured in the forwarding rule.
attr_vserver_group_id	ros_cdk_core.IResolvable	Attribute VserverGroupId: The ID of the vServer group that is associated with the forwarding rule.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_cookie^Required

attr_cookie: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_cookie_timeout^Required

attr_cookie_timeout: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute CookieTimeout: The timeout period of a cookie.

---

attr_domain^Required

attr_domain: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_health_check^Required

attr_health_check: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute HealthCheck: Specifies whether to enable health checks.

---

attr_health_check_connect_port^Required

attr_health_check_connect_port: IResolvable

• Type: 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_domain^Required

attr_health_check_domain: IResolvable

• Type: 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_code^Required

attr_health_check_http_code: IResolvable

• Type: 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_interval^Required

attr_health_check_interval: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_health_check_timeout^Required

attr_health_check_timeout: IResolvable

• Type: 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_uri^Required

attr_health_check_uri: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_healthy_threshold^Required

attr_healthy_threshold: IResolvable

• Type: 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_port^Required

attr_listener_port: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_listener_sync^Required

attr_listener_sync: IResolvable

• Type: 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^Required

attr_load_balancer_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute LoadBalancerId: The ID of the SLB instance.

---

attr_rule_id^Required

attr_rule_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RuleId: The ID of the forwarding rule.

---

attr_rule_name^Required

attr_rule_name: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RuleName: The name of the forwarding rule.

---

attr_scheduler^Required

attr_scheduler: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Scheduler: The scheduling algorithm.

---

attr_sticky_session^Required

attr_sticky_session: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute StickySession: Indicates whether session persistence is enabled.

Valid values: on and off.

---

attr_sticky_session_type^Required

attr_sticky_session_type: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_unhealthy_threshold^Required

attr_unhealthy_threshold: IResolvable

• Type: 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_url^Required

attr_url: IResolvable

• Type: ros_cdk_core.IResolvable

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

---

attr_vserver_group_id^Required

attr_vserver_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

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

---