EndpointGroup

This class encapsulates and extends the ROS resource type ALIYUN::GA::EndpointGroup, which is used to create an endpoint group.

Initializers

import ros_cdk_ga
ros_cdk_ga.EndpointGroup(
  scope: Construct,
  id: str,
  accelerator_id: typing.Union[str, IResolvable],
  endpoint_configurations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EndpointConfigurationsProperty]]],
  endpoint_group_region: typing.Union[str, IResolvable],
  listener_id: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable] = None,
  endpoint_group_type: typing.Union[str, IResolvable] = None,
  endpoint_request_protocol: typing.Union[str, IResolvable] = None,
  health_check_enabled: typing.Union[bool, IResolvable] = None,
  health_check_interval_seconds: typing.Union[typing.Union[int, float], IResolvable] = None,
  health_check_path: typing.Union[str, IResolvable] = None,
  health_check_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  health_check_protocol: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  threshold_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  traffic_percentage: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
accelerator_id	typing.Union[str, ros_cdk_core.IResolvable]	Property acceleratorId: The ID of the Global Accelerator instance with which the endpoint group will be associated.
endpoint_configurations	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EndpointConfigurationsProperty]]]	Property endpointConfigurations:.
endpoint_group_region	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointGroupRegion: The region ID of the endpoint group.
listener_id	typing.Union[str, ros_cdk_core.IResolvable]	Property listenerId: The ID of the listener to be associated with the endpoint group.
description	typing.Union[str, ros_cdk_core.IResolvable]	Property description: The description of the endpoint group.
endpoint_group_type	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointGroupType: The type of the endpoint group.
endpoint_request_protocol	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointRequestProtocol: The protocol used by the backend service.
health_check_enabled	typing.Union[bool, ros_cdk_core.IResolvable]	Property healthCheckEnabled: Specifies whether to enable the health check feature.
health_check_interval_seconds	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property healthCheckIntervalSeconds: The interval between two consecutive health checks.
health_check_path	typing.Union[str, ros_cdk_core.IResolvable]	Property healthCheckPath: The path set as the destination on the targets for health checks.
health_check_port	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property healthCheckPort: The port that is used to connect with the targets for health checks.
health_check_protocol	typing.Union[str, ros_cdk_core.IResolvable]	Property healthCheckProtocol: The protocol that is used to connect with the targets for health checks.
name	typing.Union[str, ros_cdk_core.IResolvable]	Property name: The name of the endpoint group.
threshold_count	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property thresholdCount: The number of consecutive health check failures that must occur before a healthy endpoint is considered unhealthy, or the number of consecutive health check successes that must occur before an unhealthy endpoint is considered healthy.
traffic_percentage	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property trafficPercentage: The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

accelerator_id^Required

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

Property acceleratorId: The ID of the Global Accelerator instance with which the endpoint group will be associated.

---

endpoint_configurations^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EndpointConfigurationsProperty]]]

Property endpointConfigurations:.

---

endpoint_group_region^Required

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

Property endpointGroupRegion: The region ID of the endpoint group.

---

listener_id^Required

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

Property listenerId: The ID of the listener to be associated with the endpoint group.

---

description^Optional

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

Property description: The description of the endpoint group.

---

endpoint_group_type^Optional

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

Property endpointGroupType: The type of the endpoint group.

Valid values: default: The endpoint group is a default endpoint group. This is the default value. virtual: The endpoint group is a virtual endpoint group. Note Only HTTP and HTTPS listeners support virtual endpoint groups.

---

endpoint_request_protocol^Optional

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

Property endpointRequestProtocol: The protocol used by the backend service.

Valid values: http: This is the default value. https Note: You can set this parameter only when the listener that is associated with the endpoint group uses HTTP or HTTPS. For an HTTP listener, the backend service protocol must be HTTP.

---

health_check_enabled^Optional

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

Property healthCheckEnabled: Specifies whether to enable the health check feature.

---

health_check_interval_seconds^Optional

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

Property healthCheckIntervalSeconds: The interval between two consecutive health checks.

Unit: seconds.

---

health_check_path^Optional

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

Property healthCheckPath: The path set as the destination on the targets for health checks.

---

health_check_port^Optional

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

Property healthCheckPort: The port that is used to connect with the targets for health checks.

---

health_check_protocol^Optional

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

Property healthCheckProtocol: The protocol that is used to connect with the targets for health checks.

tcp: TCP protocol http: HTTP protocol https: HTTPS protocol

---

name^Optional

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

Property name: The name of the endpoint group.

---

threshold_count^Optional

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

Property thresholdCount: The number of consecutive health check failures that must occur before a healthy endpoint is considered unhealthy, or the number of consecutive health check successes that must occur before an unhealthy endpoint is considered healthy.

Valid values: 2 to 10. Default value: 3.

---

traffic_percentage^Optional

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

Property trafficPercentage: The weight of the endpoint group when the corresponding listener is associated with multiple endpoint groups.

---

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

import ros_cdk_ga
ros_cdk_ga.EndpointGroup.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_endpoint_group_id	ros_cdk_core.IResolvable	Attribute EndpointGroupId: The ID of the endpoint group.

---

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

attr_endpoint_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute EndpointGroupId: The ID of the endpoint group.

---