Skip to content

InstanceGroupProps

Properties for defining a InstanceGroup.

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

Initializer 

import { InstanceGroupProps } from '@alicloud/ros-cdk-cloudphone'
const instanceGroupProps: InstanceGroupProps = { ... }

Properties

Name Type Description
imageId string | @alicloud/ros-cdk-core.IResolvable Property imageId: The image id.
instanceType string | @alicloud/ros-cdk-core.IResolvable Property instanceType: instance type.
securityGroupId string | @alicloud/ros-cdk-core.IResolvable Property securityGroupId: Security group to create ecs instance.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: vswitch id.
amount number | @alicloud/ros-cdk-core.IResolvable Property amount: Specifies the number of ECS instances to create.Value range: 1~100 Default：1.
autoPay boolean | @alicloud/ros-cdk-core.IResolvable Property autoPay: Whether to pay automatically, the default is true.
autoRenew boolean | @alicloud/ros-cdk-core.IResolvable Property autoRenew: Whether renew the fee automatically.
chargeType string | @alicloud/ros-cdk-core.IResolvable Property chargeType: Instance internet access charge type.
description string | @alicloud/ros-cdk-core.IResolvable Property description: Description of instance.
eipBandwidth number | @alicloud/ros-cdk-core.IResolvable Property eipBandwidth: EIP bandwidth value, the value range is 1-200.
instanceName string | @alicloud/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 ".", "-".
keyPairName string | @alicloud/ros-cdk-core.IResolvable Property keyPairName: Cloud phone instance key pair name.
period number | @alicloud/ros-cdk-core.IResolvable Property period: Prepaid time period.
periodUnit string | @alicloud/ros-cdk-core.IResolvable Property periodUnit: Unit of prepaid time period, it could be Month\/Year.
resolution string | @alicloud/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 @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.RosTag[] Property tag: Tags to attach to instance.
vncPassword string | @alicloud/ros-cdk-core.IResolvable Property vncPassword: Cloud phone VNC password.

imageIdRequired 

public readonly imageId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property imageId: The image id.

instanceTypeRequired 

public readonly instanceType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property instanceType: instance type.

securityGroupIdRequired 

public readonly securityGroupId: string | IResolvable;
  • Type: string | @alicloud/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.

vSwitchIdRequired 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: vswitch id.

amountOptional 

public readonly amount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

autoPayOptional 

public readonly autoPay: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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

autoRenewOptional 

public readonly autoRenew: boolean | IResolvable;
  • Type: boolean | @alicloud/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.

chargeTypeOptional 

public readonly chargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property chargeType: Instance internet access charge type.

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/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:\/\/.

eipBandwidthOptional 

public readonly eipBandwidth: number | IResolvable;
  • Type: number | @alicloud/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.

instanceNameOptional 

public readonly instanceName: string | IResolvable;
  • Type: string | @alicloud/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 ".", "-".

keyPairNameOptional 

public readonly keyPairName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property keyPairName: Cloud phone instance key pair name.

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

periodOptional 

public readonly period: number | IResolvable;
  • Type: number | @alicloud/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.

periodUnitOptional 

public readonly periodUnit: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Default value is Month.

resolutionOptional 

public readonly resolution: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly tag: IResolvable | IResolvable | RosTag[];
  • Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | @alicloud/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.

vncPasswordOptional 

public readonly vncPassword: string | IResolvable;
  • Type: string | @alicloud/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.