DBClusterEndpointAddress

This class encapsulates and extends the ROS resource type ALIYUN::POLARDB::DBClusterEndpointAddress, which is used to create a public endpoint for an Apsara PolarDB cluster.

The public endpoint can be a primary endpoint, the default cluster endpoint, or a custom cluster endpoint.

Initializers

import ros_cdk_polardb
ros_cdk_polardb.DBClusterEndpointAddress(
  scope: Construct,
  id: str,
  db_cluster_id: typing.Union[str, IResolvable],
  db_endpoint_id: typing.Union[str, IResolvable],
  connection_string_prefix: typing.Union[str, IResolvable] = None,
  net_type: 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.
db_cluster_id	typing.Union[str, ros_cdk_core.IResolvable]	Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a public connection point is to be created.
db_endpoint_id	typing.Union[str, ros_cdk_core.IResolvable]	Property dbEndpointId: The ID of the cluster connection point.
connection_string_prefix	typing.Union[str, ros_cdk_core.IResolvable]	Property connectionStringPrefix: The prefix of the connection string.
net_type	typing.Union[str, ros_cdk_core.IResolvable]	Property netType: The network type of the connection string.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

db_cluster_id^Required

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

Property dbClusterId: The ID of the ApsaraDB for POLARDB cluster for which a public connection point is to be created.

---

db_endpoint_id^Required

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

Property dbEndpointId: The ID of the cluster connection point.

---

connection_string_prefix^Optional

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

Property connectionStringPrefix: The prefix of the connection string.

The prefix must comply with the following rules: It must start with a letter and consist of lowercase letters, digits, and hyphens(-), cannot end with a dash. The length is 6~30 characters.

---

net_type^Optional

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

Property netType: The network type of the connection string.

If set to Public, ROS will create, modify and delete Public address for you. If set to Private, ROS will only modify Private address for you. Default to Public.

---

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_polardb
ros_cdk_polardb.DBClusterEndpointAddress.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_address	ros_cdk_core.IResolvable	Attribute Address: The details of the endpoint address.
attr_connection_string	ros_cdk_core.IResolvable	Attribute ConnectionString: The connection string of the endpoint address.

---

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

attr_address: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Address: The details of the endpoint address.

---

attr_connection_string^Required

attr_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ConnectionString: The connection string of the endpoint address.

---