HostAccountProps
Properties for defining a HostAccount.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-bastionhost-hostaccount
Initializer
import com.aliyun.ros.cdk.bastionhost.HostAccountProps;
HostAccountProps.builder()
.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();
Properties
| Name | Type | Description |
|---|---|---|
hostAccountName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property hostAccountName: The name of the new host account. |
hostId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property hostId: The ID of the host. |
instanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property instanceId: The ID of the bastion host instance. |
protocolName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property protocolName: The protocol name of the host account. |
hostShareKeyId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property hostShareKeyId: The ID of the host share key. |
passPhrase | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property passPhrase: The passphrase of the host account. |
password | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property password: The password of the host account. |
privateKey | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property privateKey: The private key of the new host account. |
privilegeType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property privilegeType: The permission type of the account. |
rotationMode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property rotationMode: The password change mode for the account. |
hostAccountNameRequired
public java.lang.Object getHostAccountName();
- 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.
hostIdRequired
public java.lang.Object getHostId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property hostId: The ID of the host.
instanceIdRequired
public java.lang.Object getInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The ID of the bastion host instance.
protocolNameRequired
public java.lang.Object getProtocolName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property protocolName: The protocol name of the host account.
Valid values: SSH, RDP.
hostShareKeyIdOptional
public java.lang.Object getHostShareKeyId();
- 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.
passPhraseOptional
public java.lang.Object getPassPhrase();
- 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.
passwordOptional
public java.lang.Object getPassword();
- 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.
privateKeyOptional
public java.lang.Object getPrivateKey();
- 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.
privilegeTypeOptional
public java.lang.Object getPrivilegeType();
- 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.
rotationModeOptional
public java.lang.Object getRotationMode();
- 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.