Skip to content

HostProps

Properties for defining a Host.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-bastionhost-host

Initializer 

import ros_cdk_bastionhost
ros_cdk_bastionhost.HostProps(
  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
)

Properties

Name Type 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.

active_address_typeRequired 

active_address_type: typing.Union[str, IResolvable]
  • 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_nameRequired 

host_name: typing.Union[str, IResolvable]
  • 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_idRequired 

instance_id: typing.Union[str, IResolvable]
  • 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_typeRequired 

os_type: typing.Union[str, IResolvable]
  • 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

sourceRequired 

source: typing.Union[str, IResolvable]
  • 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

commentOptional 

comment: typing.Union[str, IResolvable]
  • 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_addressOptional 

host_private_address: typing.Union[str, IResolvable]
  • 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_addressOptional 

host_public_address: typing.Union[str, IResolvable]
  • 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_idOptional 

instance_region_id: typing.Union[str, IResolvable]
  • 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_idOptional 

source_instance_id: typing.Union[str, IResolvable]
  • 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.