BasicEndpoint

This class encapsulates and extends the ROS resource type ALIYUN::GA::BasicEndpoint, which is used to create an endpoint for a basic Global Accelerator (GA) instance.

Initializers

import ros_cdk_ga
ros_cdk_ga.BasicEndpoint(
  scope: Construct,
  id: str,
  accelerator_id: typing.Union[str, IResolvable],
  endpoint_address: typing.Union[str, IResolvable],
  endpoint_group_id: typing.Union[str, IResolvable],
  endpoint_sub_address: typing.Union[str, IResolvable] = None,
  endpoint_sub_address_type: typing.Union[str, IResolvable] = None,
  endpoint_type: typing.Union[str, IResolvable] = None,
  endpoint_zone_id: typing.Union[str, IResolvable] = None,
  name: 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.
accelerator_id	typing.Union[str, ros_cdk_core.IResolvable]	Property acceleratorId: The ID of the basic GA instance.
endpoint_address	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointAddress: The address of the endpoint.
endpoint_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointGroupId: The ID of the endpoint group.
endpoint_sub_address	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointSubAddress: The secondary address of the endpoint.
endpoint_sub_address_type	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointSubAddressType: The type of the secondary address of the endpoint.
endpoint_type	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointType: The type of the endpoint.
endpoint_zone_id	typing.Union[str, ros_cdk_core.IResolvable]	Property endpointZoneId: The zone ID of the endpoint.
name	typing.Union[str, ros_cdk_core.IResolvable]	Property name: The name of the endpoint that is associated with the basic GA instance.
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 basic GA instance.

---

endpoint_address^Required

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

Property endpointAddress: The address of the endpoint.

---

endpoint_group_id^Required

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

Property endpointGroupId: The ID of the endpoint group.

---

endpoint_sub_address^Optional

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

Property endpointSubAddress: The secondary address of the endpoint.

This parameter is required if the endpoint type is ECS, ENI, or NLB. If the endpoint type is ECS, you can set EndpointSubAddress to the secondary private IP address of the primary ENI. If the parameter is left empty, the primary private IP address of the primary ENI is used. If the endpoint type is ENI, you can set EndpointSubAddress to the secondary private IP address of the secondary ENI. If the parameter is left empty, the primary private IP address of the secondary ENI is used. This parameter is required if the endpoint type is NLB. EndpointSubAddress is the primary private IP address of the NLB backend server.This parameter is required if the endpoint type is NLB. EndpointSubAddress is the primary private IP address of the NLB backend server.

---

endpoint_sub_address_type^Optional

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

Property endpointSubAddressType: The type of the secondary address of the endpoint.

Valid values: primary: a primary private IP address. secondary: a secondary private IP address. This parameter is required if the endpoint type is ECS, ENI, or NLB. If the endpoint type is NLB, only primary is supported.

---

endpoint_type^Optional

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

Property endpointType: The type of the endpoint.

Valid values: ENI: elastic network interface (ENI) SLB: Classic Load Balancer (CLB) NLB: Network Load Balancer (NLB) ECS: Elastic Compute Service (ECS)

---

endpoint_zone_id^Optional

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

Property endpointZoneId: The zone ID of the endpoint.

This parameter is required only if the endpoint type is NLB.

---

name^Optional

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

Property name: The name of the endpoint that is associated with the basic GA instance.

The name must be 1 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

---

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.BasicEndpoint.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_id	ros_cdk_core.IResolvable	Attribute EndpointId: The ID of the endpoint.

---

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

attr_endpoint_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute EndpointId: The ID of the endpoint.

---