Skip to content

HaVip

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::HaVip, which is used to query a high-availability virtual IP address (HAVIP).

Initializers 

from ros_cdk_vpc import datasource
datasource.HaVip(
  scope: Construct,
  id: str,
  ha_vip_id: typing.Union[str, IResolvable],
  refresh_options: 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.
ha_vip_id typing.Union[str, ros_cdk_core.IResolvable] Property haVipId: The ID of the resource.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

ha_vip_idRequired

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

Property haVipId: The ID of the resource.

refresh_optionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

from ros_cdk_vpc import datasource
datasource.HaVip.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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_associated_eip_addresses ros_cdk_core.IResolvable Attribute AssociatedEipAddresses: EIP bound to HaVip.
attr_associated_instances ros_cdk_core.IResolvable Attribute AssociatedInstances: An ECS instance that is bound to HaVip.
attr_associated_instance_type ros_cdk_core.IResolvable Attribute AssociatedInstanceType: The type of the instance that is bound to the VIIP.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The creation time of the resource.
attr_description ros_cdk_core.IResolvable Attribute Description: Dependence of a HaVip instance.
attr_ha_vip_id ros_cdk_core.IResolvable Attribute HaVipId: The ID of the resource.
attr_ha_vip_name ros_cdk_core.IResolvable Attribute HaVipName: The name of the HaVip instance.
attr_ip_address ros_cdk_core.IResolvable Attribute IpAddress: IP address of private network.
attr_master_instance_id ros_cdk_core.IResolvable Attribute MasterInstanceId: The primary instance ID bound to HaVip.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: The VPC ID to which the HaVip instance belongs.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: The switch ID to which the HaVip instance belongs.

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_associated_eip_addressesRequired 

attr_associated_eip_addresses: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AssociatedEipAddresses: EIP bound to HaVip.

attr_associated_instancesRequired 

attr_associated_instances: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AssociatedInstances: An ECS instance that is bound to HaVip.

attr_associated_instance_typeRequired 

attr_associated_instance_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AssociatedInstanceType: The type of the instance that is bound to the VIIP.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation time of the resource.

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: Dependence of a HaVip instance.

attr_ha_vip_idRequired 

attr_ha_vip_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HaVipId: The ID of the resource.

attr_ha_vip_nameRequired 

attr_ha_vip_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HaVipName: The name of the HaVip instance.

attr_ip_addressRequired 

attr_ip_address: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IpAddress: IP address of private network.

attr_master_instance_idRequired 

attr_master_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MasterInstanceId: The primary instance ID bound to HaVip.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: The VPC ID to which the HaVip instance belongs.

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: The switch ID to which the HaVip instance belongs.