Skip to content

HostProps

Properties for defining a Host.

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

Initializer

import com.aliyun.ros.cdk.bastionhost.HostProps;
HostProps.builder()
    .activeAddressType(java.lang.String)
    .activeAddressType(IResolvable)
    .hostName(java.lang.String)
    .hostName(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .osType(java.lang.String)
    .osType(IResolvable)
    .source(java.lang.String)
    .source(IResolvable)
//  .comment(java.lang.String)
//  .comment(IResolvable)
//  .hostPrivateAddress(java.lang.String)
//  .hostPrivateAddress(IResolvable)
//  .hostPublicAddress(java.lang.String)
//  .hostPublicAddress(IResolvable)
//  .instanceRegionId(java.lang.String)
//  .instanceRegionId(IResolvable)
//  .sourceInstanceId(java.lang.String)
//  .sourceInstanceId(IResolvable)
    .build();

Properties

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

activeAddressTypeRequired

public java.lang.Object getActiveAddressType();
  • Type: java.lang.String OR com.aliyun.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


hostNameRequired

public java.lang.Object getHostName();
  • Type: java.lang.String OR com.aliyun.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.


instanceIdRequired

public java.lang.Object getInstanceId();
  • Type: java.lang.String OR com.aliyun.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.


osTypeRequired

public java.lang.Object getOsType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values:

  • Linux
  • Windows

sourceRequired

public java.lang.Object getSource();
  • Type: java.lang.String OR com.aliyun.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

public java.lang.Object getComment();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

The value can be up to 500 characters.


hostPrivateAddressOptional

public java.lang.Object getHostPrivateAddress();
  • Type: java.lang.String OR com.aliyun.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.


hostPublicAddressOptional

public java.lang.Object getHostPublicAddress();
  • Type: java.lang.String OR com.aliyun.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.


instanceRegionIdOptional

public java.lang.Object getInstanceRegionId();
  • Type: java.lang.String OR com.aliyun.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.


sourceInstanceIdOptional

public java.lang.Object getSourceInstanceId();
  • Type: java.lang.String OR com.aliyun.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.