HostAccount

• Implements: IHostAccount

This class encapsulates and extends the ROS resource type ALIYUN::BastionHost::HostAccount.

Initializers

import com.aliyun.ros.cdk.bastionhost.HostAccount;
HostAccount.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .hostAccountName(java.lang.String)
    .hostAccountName(IResolvable)
    .hostId(java.lang.String)
    .hostId(IResolvable)
    .instanceId(java.lang.String)
    .instanceId(IResolvable)
    .protocolName(java.lang.String)
    .protocolName(IResolvable)
//  .hostShareKeyId(java.lang.String)
//  .hostShareKeyId(IResolvable)
//  .passPhrase(java.lang.String)
//  .passPhrase(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .privateKey(java.lang.String)
//  .privateKey(IResolvable)
//  .privilegeType(java.lang.String)
//  .privilegeType(IResolvable)
//  .rotationMode(java.lang.String)
//  .rotationMode(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

hostAccountName^Required

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

Property hostAccountName: The name of the new host account.

The name can be up to 128 characters long.

hostId^Required

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

Property hostId: The ID of the host.

instanceId^Required

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

Property instanceId: The ID of the bastion host instance.

protocolName^Required

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

Property protocolName: The protocol name of the host account.

Valid values: SSH, RDP.

hostShareKeyId^Optional

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

Property hostShareKeyId: The ID of the host share key.

This parameter is required when the protocol is SSH.

passPhrase^Optional

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

Property passPhrase: The passphrase of the host account.

This parameter is required when the protocol is SSH and the private key is encrypted.

password^Optional

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

Property password: The password of the host account.

This parameter is required when the protocol is SSH or RDP.

privateKey^Optional

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

Property privateKey: The private key of the new host account.

The value is a Base64-encoded string.

This parameter is used only when ProtocolName is set to SSH. You do not need to set this parameter if ProtocolName is set to RDP. You can set both a password and a private key for the host account. When connecting to the asset, Bastionhost prioritizes the private key for the connection.

privilegeType^Optional

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

Property privilegeType: The permission type of the account.

If you do not set this parameter, the default value is Normal.

• Privileged: privileged account
• Normal: normal account

This parameter is supported only in Bastionhost V3.2.47 and later.

rotationMode^Optional

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

Property rotationMode: The password change mode for the account.

If you do not set this parameter, the default value is Self.

• Privileged: Use a privileged account to change the password.
• Self: Do not use a privileged account to change the password.

This parameter is supported only in Bastionhost V3.2.47 and later.

Methods

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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

attrHostAccountId^Required

public java.lang.Object getAttrHostAccountId();

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

Attribute HostAccountId: The ID of the host account.

props^Required

public HostAccountProps getProps();

• Type: HostAccountProps