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 com.aliyun.ros.cdk.bastionhost.Host;
Host.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No 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.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

activeAddressType^Required

• 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

---

hostName^Required

• 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.

---

instanceId^Required

• 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.

---

osType^Required

• 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

---

source^Required

• 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

---

comment^Optional

• 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.

---

hostPrivateAddress^Optional

• 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.

---

hostPublicAddress^Optional

• 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.

---

instanceRegionId^Optional

• 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.

---

sourceInstanceId^Optional

• 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.

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

import com.aliyun.ros.cdk.bastionhost.Host;
Host.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

Name	Type	Description
node	com.aliyun.ros.cdk.core.ConstructNode	The construct tree node associated with this construct.
ref	java.lang.String	No description.
stack	com.aliyun.ros.cdk.core.Stack	The stack in which this resource is defined.
resource	com.aliyun.ros.cdk.core.RosResource	No description.
attrHostId	com.aliyun.ros.cdk.core.IResolvable	Attribute HostId: The ID of the host that was created.

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrHostId^Required

public IResolvable getAttrHostId();

• Type: com.aliyun.ros.cdk.core.IResolvable

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

---