Skip to content

InstanceGroupProps

Properties for defining a InstanceGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cloudphone-instancegroup

Initializer

import ros_cdk_cloudphone
ros_cdk_cloudphone.InstanceGroupProps(
  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
)

Properties

Name Type 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.

image_idRequired

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

Property imageId: The image id.


instance_typeRequired

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

Property instanceType: instance type.


security_group_idRequired

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

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

Property vSwitchId: vswitch id.


amountOptional

amount: typing.Union[typing.Union[int, float], IResolvable]
  • 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

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

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


auto_renewOptional

auto_renew: typing.Union[bool, IResolvable]
  • 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

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

Property chargeType: Instance internet access charge type.


descriptionOptional

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

eip_bandwidth: typing.Union[typing.Union[int, float], IResolvable]
  • 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

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

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

period: typing.Union[typing.Union[int, float], IResolvable]
  • 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

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

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

tag: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RosTag]]]
  • 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

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