Connection

This class encapsulates and extends the ROS resource type ALIYUN::REDIS::Connection, which is used to apply for a public endpoint for an ApsaraDB for Redis instance.

Initializers

import ros_cdk_redis
ros_cdk_redis.Connection(
  scope: Construct,
  id: str,
  connection_string_prefix: typing.Union[str, IResolvable],
  connection_type: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  port: typing.Union[typing.Union[int, float], IResolvable],
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
connection_string_prefix	typing.Union[str, ros_cdk_core.IResolvable]	Property connectionStringPrefix: The prefix of the public endpoint.
connection_type	typing.Union[str, ros_cdk_core.IResolvable]	Property connectionType: Allowed values: - Public: Public address.
instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceId: Instance ID (globally unique).
port	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property port: The service port number of the ApsaraDB for Redis instance.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

connection_string_prefix^Required

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

Property connectionStringPrefix: The prefix of the public endpoint.

The prefix must be 8 to 64 characters in length, and can contain lowercase letters and digits. It must start with a lowercase letter.

---

connection_type^Required

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

Property connectionType: Allowed values: - Public: Public address.

• Direct: Direct connection address. The instance is a cluster instance. You can apply for a direct connection endpoint as required.

---

instance_id^Required

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

Property instanceId: Instance ID (globally unique).

---

port^Required

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

Property port: The service port number of the ApsaraDB for Redis instance.

Valid values: 1024 to 65535.

---

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_redis
ros_cdk_redis.Connection.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_connection_string	ros_cdk_core.IResolvable	Attribute ConnectionString: The allocated connection string.

---

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

attr_connection_string: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ConnectionString: The allocated connection string.

---