Skip to content

HostAccountProps

Properties for defining a HostAccount.

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

Initializer

import ros_cdk_bastionhost
ros_cdk_bastionhost.HostAccountProps(
  host_account_name: typing.Union[str, IResolvable],
  host_id: typing.Union[str, IResolvable],
  instance_id: typing.Union[str, IResolvable],
  protocol_name: typing.Union[str, IResolvable],
  host_share_key_id: typing.Union[str, IResolvable] = None,
  pass_phrase: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  private_key: typing.Union[str, IResolvable] = None,
  privilege_type: typing.Union[str, IResolvable] = None,
  rotation_mode: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
host_account_name typing.Union[str, ros_cdk_core.IResolvable] Property hostAccountName: The name of the new host account.
host_id typing.Union[str, ros_cdk_core.IResolvable] Property hostId: The ID of the host.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the bastion host instance.
protocol_name typing.Union[str, ros_cdk_core.IResolvable] Property protocolName: The protocol name of the host account.
host_share_key_id typing.Union[str, ros_cdk_core.IResolvable] Property hostShareKeyId: The ID of the host share key.
pass_phrase typing.Union[str, ros_cdk_core.IResolvable] Property passPhrase: The passphrase of the host account.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: The password of the host account.
private_key typing.Union[str, ros_cdk_core.IResolvable] Property privateKey: The private key of the new host account.
privilege_type typing.Union[str, ros_cdk_core.IResolvable] Property privilegeType: The permission type of the account.
rotation_mode typing.Union[str, ros_cdk_core.IResolvable] Property rotationMode: The password change mode for the account.

host_account_nameRequired

host_account_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property hostAccountName: The name of the new host account.

The name can be up to 128 characters long.


host_idRequired

host_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property hostId: The ID of the host.


instance_idRequired

instance_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceId: The ID of the bastion host instance.


protocol_nameRequired

protocol_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property protocolName: The protocol name of the host account.

Valid values: SSH, RDP.


host_share_key_idOptional

host_share_key_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property hostShareKeyId: The ID of the host share key.

This parameter is required when the protocol is SSH.


pass_phraseOptional

pass_phrase: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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

password: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property password: The password of the host account.

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


private_keyOptional

private_key: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


privilege_typeOptional

privilege_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.


rotation_modeOptional

rotation_mode: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.