HaVip
This class encapsulates and extends the ROS resource type ALIYUN::VPC::HaVip, which is used to create a high-availability virtual IP address (HAVIP).
Initializers
import ros_cdk_vpc
ros_cdk_vpc.HaVip(
scope: Construct,
id: str,
v_switch_id: typing.Union[str, IResolvable],
description: typing.Union[str, IResolvable] = None,
ip_address: typing.Union[str, IResolvable] = None,
name: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
tags: typing.List[TagsProperty] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
v_switch_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vSwitchId: The ID of the vSwitch to which the HAVIP belongs. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: The description of the HAVIP. |
ip_address |
typing.Union[str, ros_cdk_core.IResolvable] |
Property ipAddress: The IP address of the HAVIP. |
name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property name: The name of the HAVIP. |
resource_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property resourceGroupId: The ID of the resource group to which the HAVIP belongs. |
tags |
typing.List[TagsProperty] |
Property tags: Tags to attach to instance. |
enable_resource_property_constraint |
bool |
No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
v_switch_idRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vSwitchId: The ID of the vSwitch to which the HAVIP belongs.
descriptionOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property description: The description of the HAVIP.
The description must be 1 to 256 characters in length and cannot start with http:// or https://.
ip_addressOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property ipAddress: The IP address of the HAVIP.
The specified IP address must be an idle IP address that falls within the CIDR block of the vSwitch. If this parameter is not set, an idle IP address from the CIDR block of the vSwitch is randomly assigned to the HAVIP.
nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property name: The name of the HAVIP.
The name must be 1 to 128 characters in length, and cannot start with http:// or https://.
resource_group_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: The ID of the resource group to which the HAVIP belongs.
tagsOptional
- Type: typing.List[TagsProperty]
Property tags: Tags to attach to instance.
Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.
enable_resource_property_constraintOptional
- 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_vpc
ros_cdk_vpc.HaVip.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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_ha_vip_id |
ros_cdk_core.IResolvable |
Attribute HaVipId: Assigned HaVip ID. |
attr_ip_address |
ros_cdk_core.IResolvable |
Attribute IpAddress: The IP address of the HAVIP. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
refRequired
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_ha_vip_idRequired
attr_ha_vip_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute HaVipId: Assigned HaVip ID.
attr_ip_addressRequired
attr_ip_address: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute IpAddress: The IP address of the HAVIP.