Host

This class encapsulates and extends the ROS resource type ALIYUN::BastionHost::Host, which is used to create a host for O&M in a bastion host.

Initializers

import ros_cdk_bastionhost
ros_cdk_bastionhost.Host(
  scope: Construct,
  id: str,
  active_address_type: typing.Union[str, IResolvable],
  host_name: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  os_type: typing.Union[str, IResolvable],
  source: typing.Union[str, IResolvable],
  comment: typing.Union[str, IResolvable] = None,
  host_private_address: typing.Union[str, IResolvable] = None,
  host_public_address: typing.Union[str, IResolvable] = None,
  instance_region_id: typing.Union[str, IResolvable] = None,
  source_instance_id: 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.
active_address_type	typing.Union[str, ros_cdk_core.IResolvable]	Property activeAddressType: The endpoint type of the host that you want to create.
host_name	typing.Union[str, ros_cdk_core.IResolvable]	Property hostName: The name of the host that you want to create.
instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceId: The ID of the Bastionhost instance where you want to create the host.
os_type	typing.Union[str, ros_cdk_core.IResolvable]	Property osType: The operating system of the host that you want to create.
source	typing.Union[str, ros_cdk_core.IResolvable]	Property source: The source of the host that you want to create.
comment	typing.Union[str, ros_cdk_core.IResolvable]	Property comment: The description of the host that you want to create.
host_private_address	typing.Union[str, ros_cdk_core.IResolvable]	Property hostPrivateAddress: The internal endpoint of the host that you want to create.
host_public_address	typing.Union[str, ros_cdk_core.IResolvable]	Property hostPublicAddress: The public endpoint of the host that you want to create.
instance_region_id	typing.Union[str, ros_cdk_core.IResolvable]	Property instanceRegionId: The ID of the region where the ECS instance or dedicated cluster host that you want to create resides.
source_instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property sourceInstanceId: The ID of the ECS instance or dedicated cluster host that you want to create.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

active_address_type^Required

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

Property activeAddressType: The endpoint type of the host that you want to create.

Valid values: Public: a public endpoint Private: an internal endpoint

---

host_name^Required

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

Property hostName: The name of the host that you want to create.

The name can be up to 128 characters in length.

---

instance_id^Required

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

Property instanceId: The ID of the Bastionhost instance where you want to create the host.

Note: You can call the DescribeInstances operation to query the ID of the Bastionhost instance.

---

os_type^Required

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

Property osType: The operating system of the host that you want to create.

Valid values:

• Linux
• Windows

---

source^Required

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

Property source: The source of the host that you want to create.

Valid values:

• Local: an on-premises host
• Ecs: an Elastic Compute Service (ECS) instance
• Rds: a host in a dedicated cluster

---

comment^Optional

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

Property comment: The description of the host that you want to create.

The value can be up to 500 characters.

---

host_private_address^Optional

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

Property hostPrivateAddress: The internal endpoint of the host that you want to create.

You can set this parameter to a domain name or an IP address. Note: This parameter is required if the ActiveAddressType parameter is set to Private.

---

host_public_address^Optional

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

Property hostPublicAddress: The public endpoint of the host that you want to create.

You can set this parameter to a domain name or an IP address. Note: This parameter is required if the ActiveAddressType parameter is set to Public.

---

instance_region_id^Optional

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

Property instanceRegionId: The ID of the region where the ECS instance or dedicated cluster host that you want to create resides.

Note: This parameter is required if the Source parameter is set to Ecs or Rds.

---

source_instance_id^Optional

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

Property sourceInstanceId: The ID of the ECS instance or dedicated cluster host that you want to create.

Note This parameter is required if the Source parameter is set to Ecs or Rds.

---

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_bastionhost
ros_cdk_bastionhost.Host.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_host_id	ros_cdk_core.IResolvable	Attribute HostId: The ID of the host that was created.

---

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

attr_host_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute HostId: The ID of the host that was created.

---