HostAccount

• Implements: IHostAccount

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

Initializers

import ros_cdk_bastionhost
ros_cdk_bastionhost.HostAccount(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

host_account_name^Required

• 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_id^Required

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

Property hostId: The ID of the host.

instance_id^Required

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

Property instanceId: The ID of the bastion host instance.

protocol_name^Required

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

Property protocolName: The protocol name of the host account.

Valid values: SSH, RDP.

host_share_key_id^Optional

• 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_phrase^Optional

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

password^Optional

• 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_key^Optional

• 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_type^Optional

• 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_mode^Optional

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

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_bastionhost
ros_cdk_bastionhost.HostAccount.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_host_account_id^Required

attr_host_account_id: typing.Union[str, IResolvable]

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

Attribute HostAccountId: The ID of the host account.

props^Required

props: HostAccountProps

• Type: HostAccountProps