HostProps

Properties for defining a Host.

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

Initializer

import { HostProps } from '@alicloud/ros-cdk-bastionhost'
const hostProps: HostProps = { ... }

Properties

Name	Type	Description
activeAddressType	string | @alicloud/ros-cdk-core.IResolvable	Property activeAddressType: The endpoint type of the host that you want to create.
hostName	string | @alicloud/ros-cdk-core.IResolvable	Property hostName: The name of the host that you want to create.
instanceId	string | @alicloud/ros-cdk-core.IResolvable	Property instanceId: The ID of the Bastionhost instance where you want to create the host.
osType	string | @alicloud/ros-cdk-core.IResolvable	Property osType: The operating system of the host that you want to create.
source	string | @alicloud/ros-cdk-core.IResolvable	Property source: The source of the host that you want to create.
comment	string | @alicloud/ros-cdk-core.IResolvable	Property comment: The description of the host that you want to create.
hostPrivateAddress	string | @alicloud/ros-cdk-core.IResolvable	Property hostPrivateAddress: The internal endpoint of the host that you want to create.
hostPublicAddress	string | @alicloud/ros-cdk-core.IResolvable	Property hostPublicAddress: The public endpoint of the host that you want to create.
instanceRegionId	string | @alicloud/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.
sourceInstanceId	string | @alicloud/ros-cdk-core.IResolvable	Property sourceInstanceId: The ID of the ECS instance or dedicated cluster host that you want to create.

---

activeAddressType^Required

public readonly activeAddressType: string | IResolvable;

• Type: string | @alicloud/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

---

hostName^Required

public readonly hostName: string | IResolvable;

• Type: string | @alicloud/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.

---

instanceId^Required

public readonly instanceId: string | IResolvable;

• Type: string | @alicloud/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.

---

osType^Required

public readonly osType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

Valid values: - Linux - Windows

---

source^Required

public readonly source: string | IResolvable;

• Type: string | @alicloud/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

public readonly comment: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

The value can be up to 500 characters.

---

hostPrivateAddress^Optional

public readonly hostPrivateAddress: string | IResolvable;

• Type: string | @alicloud/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.

---

hostPublicAddress^Optional

public readonly hostPublicAddress: string | IResolvable;

• Type: string | @alicloud/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.

---

instanceRegionId^Optional

public readonly instanceRegionId: string | IResolvable;

• Type: string | @alicloud/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.

---

sourceInstanceId^Optional

public readonly sourceInstanceId: string | IResolvable;

• Type: string | @alicloud/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.

---