HostAccountProps

Properties for defining a HostAccount.

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

Initializer

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

Properties

hostAccountName^Required

public readonly hostAccountName: string | IResolvable;

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

Property hostAccountName: The name of the new host account.

The name can be up to 128 characters long.

hostId^Required

public readonly hostId: string | IResolvable;

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

Property hostId: The ID of the host.

instanceId^Required

public readonly instanceId: string | IResolvable;

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

Property instanceId: The ID of the bastion host instance.

protocolName^Required

public readonly protocolName: string | IResolvable;

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

Property protocolName: The protocol name of the host account.

Valid values: SSH, RDP.

hostShareKeyId^Optional

public readonly hostShareKeyId: string | IResolvable;

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

Property hostShareKeyId: The ID of the host share key.

This parameter is required when the protocol is SSH.

passPhrase^Optional

public readonly passPhrase: string | IResolvable;

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

public readonly password: string | IResolvable;

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

public readonly privateKey: string | IResolvable;

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

public readonly privilegeType: string | IResolvable;

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

public readonly rotationMode: string | IResolvable;

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