Skip to content

InstanceGroup

This class encapsulates and extends the ROS resource type ALIYUN::CloudPhone::InstanceGroup, which is used to create and start cloud phones.

Initializers 

import ros_cdk_cloudphone
ros_cdk_cloudphone.InstanceGroup(
  scope: Construct,
  id: str,
  image_id: typing.Union[str, IResolvable],
  instance_type: typing.Union[str, IResolvable],
  security_group_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  amount: typing.Union[typing.Union[int, float], IResolvable] = None,
  auto_pay: typing.Union[bool, IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  charge_type: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  eip_bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  resolution: typing.Union[str, IResolvable] = None,
  tag: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RosTag]]] = None,
  vnc_password: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
image_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: The image id.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: instance type.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: Security group to create ecs instance.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: vswitch id.
amount typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property amount: Specifies the number of ECS instances to create.Value range: 1~100 Default：1.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Whether to pay automatically, the default is true.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: Whether renew the fee automatically.
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: Instance internet access charge type.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Description of instance.
eip_bandwidth typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property eipBandwidth: EIP bandwidth value, the value range is 1-200.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: "Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, "_" or ".", "-".
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] Property keyPairName: Cloud phone instance key pair name.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: Prepaid time period.
period_unit typing.Union[str, ros_cdk_core.IResolvable] Property periodUnit: Unit of prepaid time period, it could be Month\/Year.
resolution typing.Union[str, ros_cdk_core.IResolvable] Property resolution: You can use the DescribeInstanceTypes interface to query the list of resolutions supported by the current specification and select an appropriate resolution.
tag typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ros_cdk_core.RosTag]]] Property tag: Tags to attach to instance.
vnc_password typing.Union[str, ros_cdk_core.IResolvable] Property vncPassword: Cloud phone VNC password.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

image_idRequired

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

Property imageId: The image id.

instance_typeRequired

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

Property instanceType: instance type.

security_group_idRequired

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

Property securityGroupId: Security group to create ecs instance.

For classic instance need the security group not belong to VPC, for VPC instance, please make sure the security group belong to specified VPC.

v_switch_idRequired

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

Property vSwitchId: vswitch id.

amountOptional

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

Property amount: Specifies the number of ECS instances to create.Value range: 1~100 Default：1.

auto_payOptional

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

Property autoPay: Whether to pay automatically, the default is true.

auto_renewOptional

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

Property autoRenew: Whether renew the fee automatically.

When the parameter InstanceChargeType is PrePaid, it will take effect. Range of value:True: automatic renewal. False: no automatic renewal. Default value is False.

charge_typeOptional

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

Property chargeType: Instance internet access charge type.

descriptionOptional

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

Property description: Description of instance.

The length is 2~256 English or Chinese characters and cannot start with http:// and https://.

eip_bandwidthOptional

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

Property eipBandwidth: EIP bandwidth value, the value range is 1-200.

Setting this parameter will automatically create an EIP instance corresponding to the bandwidth and bind the EIP instance to the cloud phone instance. When the instance is released, this EIP instance will be released and recycled together.

instance_nameOptional

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

Property instanceName: "Display name of the instance, [2, 128] English or Chinese characters, must start with a letter or Chinese in size, can contain numbers, "_" or ".", "-".

key_pair_nameOptional

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

Property keyPairName: Cloud phone instance key pair name.

The cloud phone key can be imported through the ImportKeyPair interface.

periodOptional

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

Property period: Prepaid time period.

While PeriodUnit is month, it could be 1, 2, 3, 6. While PeriodUnit is year, it could be from 1 to 5Default value is 1.

period_unitOptional

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

Property periodUnit: Unit of prepaid time period, it could be Month\/Year.

Default value is Month.

resolutionOptional

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

Property resolution: You can use the DescribeInstanceTypes interface to query the list of resolutions supported by the current specification and select an appropriate resolution.

tagOptional

  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ros_cdk_core.RosTag]]]

Property tag: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

vnc_passwordOptional

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

Property vncPassword: Cloud phone VNC password.

The password must be six characters long, and must contain only uppercase, lowercase English letters and Arabic numerals.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_cloudphone
ros_cdk_cloudphone.InstanceGroup.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_instance_ids ros_cdk_core.IResolvable Attribute InstanceIds: instance ids.
attr_order_id ros_cdk_core.IResolvable Attribute OrderId: oder id.
attr_private_ips ros_cdk_core.IResolvable Attribute PrivateIps: Private IP address list of created cloud phone instances.
attr_trade_price ros_cdk_core.IResolvable Attribute TradePrice: price.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_instance_idsRequired 

attr_instance_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceIds: instance ids.

attr_order_idRequired 

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: oder id.

attr_private_ipsRequired 

attr_private_ips: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PrivateIps: Private IP address list of created cloud phone instances.

Only for VPC instance.

attr_trade_priceRequired 

attr_trade_price: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TradePrice: price.