Rule

• Implements: 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

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
)

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

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

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

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

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

attr_cookie_timeout: typing.Union[str, IResolvable]

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

Attribute CookieTimeout: The timeout period of a cookie.

attr_domain^Required

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_check^Required

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_port^Required

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_domain^Required

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_code^Required

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_interval^Required

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_timeout^Required

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_uri^Required

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_threshold^Required

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_port^Required

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_sync^Required

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_id^Required

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_id^Required

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_name^Required

attr_rule_name: typing.Union[str, IResolvable]

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

Attribute RuleName: The name of the forwarding rule.

attr_scheduler^Required

attr_scheduler: typing.Union[str, IResolvable]

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

Attribute Scheduler: The scheduling algorithm.

attr_sticky_session^Required

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_type^Required

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_threshold^Required

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_url^Required

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_id^Required

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.

props^Required

props: RuleProps

• Type: RuleProps