Skip to content

InstanceGroupCloneProps

Properties for defining a InstanceGroupClone.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-instancegroupclone

Initializer

import ros_cdk_ecs
ros_cdk_ecs.InstanceGroupCloneProps(
  max_amount: typing.Union[typing.Union[int, float], IResolvable],
  source_instance_id: typing.Union[str, IResolvable],
  auto_release_time: typing.Union[str, IResolvable] = None,
  auto_renew: typing.Union[str, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  backend_server_weight: typing.Union[typing.Union[int, float], IResolvable] = None,
  cpu_options: typing.Union[IResolvable, CpuOptionsProperty] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  deployment_set_id: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  disk_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DiskMappingsProperty]]] = None,
  eni_mappings: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EniMappingsProperty]]] = None,
  host_names: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  hpc_cluster_id: typing.Union[str, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  image_options: typing.Union[IResolvable, ImageOptionsProperty] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  internet_max_bandwidth_in: typing.Union[typing.Union[int, float], IResolvable] = None,
  internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable] = None,
  ipv6_address_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  ipv6_addresses: typing.Union[typing.List[typing.Any], IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  launch_template_id: typing.Union[str, IResolvable] = None,
  launch_template_name: typing.Union[str, IResolvable] = None,
  launch_template_version: typing.Union[str, IResolvable] = None,
  load_balancer_id_to_attach: typing.Union[str, IResolvable] = None,
  network_interface_queue_number: typing.Union[typing.Union[int, float], IResolvable] = None,
  network_options: typing.Union[IResolvable, NetworkOptionsProperty] = None,
  password: typing.Union[str, IResolvable] = None,
  password_inherit: typing.Union[bool, IResolvable] = None,
  period: typing.Union[typing.Union[int, float], IResolvable] = None,
  period_unit: typing.Union[str, IResolvable] = None,
  ram_role_name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  security_group_id: typing.Union[str, IResolvable] = None,
  security_group_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  security_options: typing.Union[IResolvable, SecurityOptionsProperty] = None,
  spot_price_limit: typing.Union[str, IResolvable] = None,
  spot_strategy: typing.Union[str, IResolvable] = None,
  system_disk_auto_snapshot_policy_id: typing.Union[str, IResolvable] = None,
  system_disk_bursting_enabled: typing.Union[bool, IResolvable] = None,
  system_disk_category: typing.Union[str, IResolvable] = None,
  system_disk_description: typing.Union[str, IResolvable] = None,
  system_disk_disk_name: typing.Union[str, IResolvable] = None,
  system_disk_encrypt_algorithm: typing.Union[str, IResolvable] = None,
  system_disk_encrypted: typing.Union[str, IResolvable] = None,
  system_disk_kms_key_id: typing.Union[str, IResolvable] = None,
  system_disk_provisioned_iops: typing.Union[typing.Union[int, float], IResolvable] = None,
  system_disk_storage_cluster_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  unique_suffix: typing.Union[bool, IResolvable] = None,
  update_policy: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
max_amount typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxAmount: Max number of instances to create, should be bigger than 'MinAmount' and smaller than 1000.
source_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property sourceInstanceId: Source ecs instance used to copy properties to clone new ecs instance.
auto_release_time typing.Union[str, ros_cdk_core.IResolvable] Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.
auto_renew typing.Union[str, ros_cdk_core.IResolvable] Property autoRenew: Whether renew the fee automatically?
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoRenewPeriod: The time period of auto renew.
backend_server_weight typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property backendServerWeight: The weight of backend server of load balancer.
cpu_options typing.Union[ros_cdk_core.IResolvable, CpuOptionsProperty] Property cpuOptions: Cpu options.
deletion_protection typing.Union[bool, ros_cdk_core.IResolvable] Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.
deployment_set_id typing.Union[str, ros_cdk_core.IResolvable] Property deploymentSetId: Deployment set ID.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Description of the instance, [2, 256] characters.
disk_mappings typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DiskMappingsProperty]]] Property diskMappings: Disk mappings to attach to instance.
eni_mappings typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EniMappingsProperty]]] Property eniMappings: NetworkInterface to attach to instance.
host_names typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property hostNames: The hostname of instance N.
hpc_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property hpcClusterId: The HPC cluster ID to which the instance belongs.The change of the property does not affect existing instances.
image_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: Image ID to create ecs instance.
image_options typing.Union[ros_cdk_core.IResolvable, ImageOptionsProperty] Property imageOptions: Image options.
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 '.', '-'. Support to use the regular expression to set the different instance name for each ECS instance. InstanceName could be specified as 'name_prefix[begin_number,bits]name_suffix', such as 'testinstance[123,4]tail'. If you creates 3 instances with the instance name 'testinstance[123,4]tail', all the instances' names are testinstance0123tail, testinstance0124tail, testinstance0125tail. The 'name_prefix[begin_number,bits]name_suffix' should follow those rules: 1. 'name_prefix' is required. 2. 'name_suffix' is optional. 3. The name regular expression can't include any spaces. 4. The 'bits' must be in range [1, 6]. 5. The 'begin_number' must be in range [0, 999999]. 6. You could only specify 'begin_number'. The 'bits' will be set as 6 by default. 7. You also could only specify the [] or [,]. The 'begin_number' will be set as 0 by default, the 'bits' will be set as 6 by default. 8. If the bits of 'begin_number' is less than the 'bits' you specified, like [1234,1], the 'bits' will be set as 6 by default.
internet_max_bandwidth_in typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property internetMaxBandwidthIn: Max internet out band width setting, unit in Mbps(Mega bit per second).
internet_max_bandwidth_out typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property internetMaxBandwidthOut: Set internet output bandwidth of instance.
ipv6_address_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property ipv6AddressCount: Specifies the number of randomly generated IPv6 addresses for the elastic NIC.
ipv6_addresses typing.Union[typing.List[typing.Any], ros_cdk_core.IResolvable] Property ipv6Addresses: Specify one or more IPv6 addresses for the elastic NIC.
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] Property keyPairName: SSH key pair name.Old instances will not be changed.
launch_template_id typing.Union[str, ros_cdk_core.IResolvable] Property launchTemplateId: ID of launch template.
launch_template_name typing.Union[str, ros_cdk_core.IResolvable] Property launchTemplateName: Name of launch template.
launch_template_version typing.Union[str, ros_cdk_core.IResolvable] Property launchTemplateVersion: Version of launch template.
load_balancer_id_to_attach typing.Union[str, ros_cdk_core.IResolvable] Property loadBalancerIdToAttach: After the instance is created.
network_interface_queue_number typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property networkInterfaceQueueNumber: The number of queues supported by the primary ENI.
network_options typing.Union[ros_cdk_core.IResolvable, NetworkOptionsProperty] Property networkOptions: Network options.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: Password of created ecs instance.
password_inherit typing.Union[bool, ros_cdk_core.IResolvable] Property passwordInherit: Specifies whether to use the password preset in the image.
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 Week\/Month\/Year.
ram_role_name typing.Union[str, ros_cdk_core.IResolvable] Property ramRoleName: Instance RAM role name.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: Resource group id.
security_group_id typing.Union[str, ros_cdk_core.IResolvable] Property securityGroupId: Security group to create ecs instance.
security_group_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property securityGroupIds: The IDs of security groups N to which the instance belongs.
security_options typing.Union[ros_cdk_core.IResolvable, SecurityOptionsProperty] Property securityOptions: Security options.
spot_price_limit typing.Union[str, ros_cdk_core.IResolvable] Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
spot_strategy typing.Union[str, ros_cdk_core.IResolvable] Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.
system_disk_auto_snapshot_policy_id typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.
system_disk_bursting_enabled typing.Union[bool, ros_cdk_core.IResolvable] Property systemDiskBurstingEnabled: Whether enable bursting.
system_disk_category typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskCategory: Category of system disk.
system_disk_description typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskDescription: Description of created system disk.Old instances will not be changed.
system_disk_disk_name typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskDiskName: Name of created system disk.Old instances will not be changed.
system_disk_encrypt_algorithm typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskEncryptAlgorithm: The algorithm to use to encrypt the system disk.
system_disk_encrypted typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskEncrypted: Specifies whether to encrypt the system disk.
system_disk_kms_key_id typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskKmsKeyId: The ID of the KMS key to use for the system disk.
system_disk_provisioned_iops typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property systemDiskProvisionedIops: Provisioning IOPS.
system_disk_storage_cluster_id typing.Union[str, ros_cdk_core.IResolvable] Property systemDiskStorageClusterId: The ID of the dedicated block storage cluster.
tags typing.List[TagsProperty] Property tags: Tags to attach to instance.
unique_suffix typing.Union[bool, ros_cdk_core.IResolvable] Property uniqueSuffix: Specifies whether to automatically append incremental suffixes to the hostname specified by the HostName parameter and to the instance name specified by the InstanceName parameter when you batch create instances.
update_policy typing.Union[str, ros_cdk_core.IResolvable] Property updatePolicy: Specify the policy at update.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The ID of the zone to which the instance belongs.

max_amountRequired

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

Property maxAmount: Max number of instances to create, should be bigger than 'MinAmount' and smaller than 1000.


source_instance_idRequired

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

Property sourceInstanceId: Source ecs instance used to copy properties to clone new ecs instance.

It will copy the InstanceType, ImageId, InternetChargeType, InternetMaxBandwidthIn, InternetMaxBandwidthOut and the system disk and data disk configurations. If the instance network is VPC, it will also clone the relative properties. If specified instance with more than one security group, it will use the first security group to create instance. you can also specify the SecurityGroupId to override it.


auto_release_timeOptional

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

Property autoReleaseTime: Auto release time for created instance, Follow ISO8601 standard using UTC time.

format is 'yyyy-MM-ddTHH:mm:ssZ'. Not bigger than 3 years from this day onwards


auto_renewOptional

auto_renew: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.Old instances will not be changed.


auto_renew_periodOptional

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

Property autoRenewPeriod: The time period of auto renew.

When the parameter InstanceChargeType is PrePaid, it will take effect.It could be 1, 2, 3, 6, 12, 24, 36, 48, 60. Default value is 1.Old instances will not be changed.


backend_server_weightOptional

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

Property backendServerWeight: The weight of backend server of load balancer.

From 0 to 100, 0 means offline. Default is 100.


cpu_optionsOptional

cpu_options: typing.Union[IResolvable, CpuOptionsProperty]

Property cpuOptions: Cpu options.


deletion_protectionOptional

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

Property deletionProtection: Whether an instance can be released manually through the console or API, deletion protection only support postPaid instance.


deployment_set_idOptional

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

Property deploymentSetId: Deployment set ID.

The change of the property does not affect existing instances.


descriptionOptional

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

Property description: Description of the instance, [2, 256] characters.

Do not fill or empty, the default is empty. Old instances will not be changed.


disk_mappingsOptional

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

Property diskMappings: Disk mappings to attach to instance.

Max support 16 disks. If the image contains a data disk, you can specify other parameters of the data disk via the same value of parameter "Device". If parameter "Category" is not specified, it will be cloud_efficiency instead of "Category" of data disk in the image.Old instances will not be changed.


eni_mappingsOptional

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

Property eniMappings: NetworkInterface to attach to instance.

Max support 2 ENIs.


host_namesOptional

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

Property hostNames: The hostname of instance N.

You can use this parameter to specify different hostnames for multiple instances. Take note of the following items:

  • The maximum value of N must be the same as the Amount value. For example, if you set Amount to 2, you can use HostNames.1 and HostNames.2 to specify hostnames for the individual instances. Examples: HostNames.1=test1 and HostNames.2=test2.
  • You cannot specify both HostName and HostNames.N.
  • The hostname cannot start or end with a period (.) or hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-).
  • For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. The hostname can contain letters, digits, and hyphens (-).
  • For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).

hpc_cluster_idOptional

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

Property hpcClusterId: The HPC cluster ID to which the instance belongs.The change of the property does not affect existing instances.


image_idOptional

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

Property imageId: Image ID to create ecs instance.


image_optionsOptional

image_options: typing.Union[IResolvable, ImageOptionsProperty]

Property imageOptions: Image options.


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 '.', '-'. Support to use the regular expression to set the different instance name for each ECS instance. InstanceName could be specified as 'name_prefix[begin_number,bits]name_suffix', such as 'testinstance[123,4]tail'. If you creates 3 instances with the instance name 'testinstance[123,4]tail', all the instances' names are testinstance0123tail, testinstance0124tail, testinstance0125tail. The 'name_prefix[begin_number,bits]name_suffix' should follow those rules: 1. 'name_prefix' is required. 2. 'name_suffix' is optional. 3. The name regular expression can't include any spaces. 4. The 'bits' must be in range [1, 6]. 5. The 'begin_number' must be in range [0, 999999]. 6. You could only specify 'begin_number'. The 'bits' will be set as 6 by default. 7. You also could only specify the [] or [,]. The 'begin_number' will be set as 0 by default, the 'bits' will be set as 6 by default. 8. If the bits of 'begin_number' is less than the 'bits' you specified, like [1234,1], the 'bits' will be set as 6 by default.


internet_max_bandwidth_inOptional

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

Property internetMaxBandwidthIn: Max internet out band width setting, unit in Mbps(Mega bit per second).

The range is [0,200], default is 200 Mbps.


internet_max_bandwidth_outOptional

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

Property internetMaxBandwidthOut: Set internet output bandwidth of instance.

Unit is Mbps(Mega bit per second). Range is [0,200]. Default is 1.While the property is not 0, public ip will be assigned for instance.


ipv6_address_countOptional

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

Property ipv6AddressCount: Specifies the number of randomly generated IPv6 addresses for the elastic NIC.

Note You cannot specify the parameters Ipv6Addresses and Ipv6AddressCount at the same time. The change of the property does not affect existing instances.


ipv6_addressesOptional

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

Property ipv6Addresses: Specify one or more IPv6 addresses for the elastic NIC.

Currently, the maximum list size is 1. Example value: 2001:db8:1234:1a00::*** . Note You cannot specify the parameters Ipv6Addresses and Ipv6AddressCount at the same time. The change of the property does not affect existing instances.


key_pair_nameOptional

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

Property keyPairName: SSH key pair name.Old instances will not be changed.


launch_template_idOptional

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

Property launchTemplateId: ID of launch template.

Launch template id or name must be specified to use launch template


launch_template_nameOptional

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

Property launchTemplateName: Name of launch template.

Launch template id or name must be specified to use launch template


launch_template_versionOptional

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

Property launchTemplateVersion: Version of launch template.

Default version is used if version is not specified.


load_balancer_id_to_attachOptional

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

Property loadBalancerIdToAttach: After the instance is created.

Automatic attach it to the load balancer.


network_interface_queue_numberOptional

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

Property networkInterfaceQueueNumber: The number of queues supported by the primary ENI.

Take note of the following items:

  • The value of this parameter cannot exceed the maximum number of queues per ENI allowed for the instance type.
  • The total number of queues for all ENIs on the instance cannot exceed the queue quota for the instance type.
  • If NetworkInterface.N.InstanceType is set to Primary, you cannot specify NetworkInterfaceQueueNumber but can specify NetworkInterface.N.QueueNumber

network_optionsOptional

network_options: typing.Union[IResolvable, NetworkOptionsProperty]

Property networkOptions: Network options.


passwordOptional

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

Property password: Password of created ecs instance.

Must contain at least 3 types of special character, lower character, upper character, number.


password_inheritOptional

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

Property passwordInherit: Specifies whether to use the password preset in the image.

To use the PasswordInherit parameter, the Password parameter must be empty and you must make sure that the selected image has a password configured.


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.

Unit is month, it could be from 1 to 9 or 12, 24, 36, 48, 60. Default value is 1.Old instances will not be changed.


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 Week\/Month\/Year.

Default value is Month.Old instances will not be changed.


ram_role_nameOptional

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

Property ramRoleName: Instance RAM role name.

The name is provided and maintained by Resource Access Management (RAM) and can be queried using ListRoles. For more information, see RAM API CreateRole and ListRoles.


resource_group_idOptional

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

Property resourceGroupId: Resource group id.


security_group_idOptional

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.


security_group_idsOptional

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

Property securityGroupIds: The IDs of security groups N to which the instance belongs.

The valid values of N are based on the maximum number of security groups to which an instance can belong. For more information, see Security group limits.Note: You cannot specify both SecurityGroupId and SecurityGroupIds at the same time.


security_optionsOptional

security_options: typing.Union[IResolvable, SecurityOptionsProperty]

Property securityOptions: Security options.


spot_price_limitOptional

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

Property spotPriceLimit: The hourly price threshold of a instance, and it takes effect only when parameter InstanceChargeType is PostPaid.

Three decimals is allowed at most.


spot_strategyOptional

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

Property spotStrategy: The spot strategy of a Pay-As-You-Go instance, and it takes effect only when parameter InstanceChargeType is PostPaid.

Value range: "NoSpot: A regular Pay-As-You-Go instance", "SpotWithPriceLimit: A price threshold for a spot instance, ""SpotAsPriceGo: A price that is based on the highest Pay-As-You-Go instance. "Default value: NoSpot.


system_disk_auto_snapshot_policy_idOptional

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

Property systemDiskAutoSnapshotPolicyId: Auto snapshot policy ID.


system_disk_bursting_enabledOptional

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

Property systemDiskBurstingEnabled: Whether enable bursting.


system_disk_categoryOptional

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

Property systemDiskCategory: Category of system disk.

Default is cloud_efficiency. support cloud|cloud_efficiency|cloud_ssd|cloud_essd|ephemeral_ssd|cloud_auto|cloud_essd_entry.Old instances will not be changed.


system_disk_descriptionOptional

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

Property systemDiskDescription: Description of created system disk.Old instances will not be changed.


system_disk_disk_nameOptional

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

Property systemDiskDiskName: Name of created system disk.Old instances will not be changed.


system_disk_encrypt_algorithmOptional

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

Property systemDiskEncryptAlgorithm: The algorithm to use to encrypt the system disk.

Valid values:

  • aes-256
  • sm4-128 Default value: aes-256.

system_disk_encryptedOptional

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

Property systemDiskEncrypted: Specifies whether to encrypt the system disk.

Valid values:

  • true: encrypts the system disk.
  • false: does not encrypt the system disk. Default value: false.

system_disk_kms_key_idOptional

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

Property systemDiskKmsKeyId: The ID of the KMS key to use for the system disk.


system_disk_provisioned_iopsOptional

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

Property systemDiskProvisionedIops: Provisioning IOPS.


system_disk_storage_cluster_idOptional

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

Property systemDiskStorageClusterId: The ID of the dedicated block storage cluster.

If you want to use disks in a dedicated block storage cluster as system disks when you create instances, you must specify this parameter.


tagsOptional

tags: typing.List[TagsProperty]

Property tags: 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.


unique_suffixOptional

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

Property uniqueSuffix: Specifies whether to automatically append incremental suffixes to the hostname specified by the HostName parameter and to the instance name specified by the InstanceName parameter when you batch create instances.

The incremental suffixes can range from 001 to 999. Valid values:

  • true: appends incremental suffixes to the hostname and the instance name.
  • false: does not append incremental suffixes to the hostname or the instance name. Default value: false. When the HostName or InstanceName value is set in the name_prefix[begin_number,bits] format without a suffix (name_suffix), the UniqueSuffix parameter does not take effect. The names are sorted in the specified sequence.

update_policyOptional

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

Property updatePolicy: Specify the policy at update.

The value can be 'ForNewInstances' or 'ForAllInstances'. If UpdatePolicy is 'ForAllInstance', The updatable parameters are InstanceType, ImageId, SystemDiskSize, SystemDiskCategory, Password, UserData,InternetChargeType, InternetMaxBandwidthOut, InternetMaxBandwidthIn. The default is 'ForNewInstances'


zone_idOptional

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

Property zoneId: The ID of the zone to which the instance belongs.

For more information, call the DescribeZones operation to query the most recent zone list. Default value is empty, which means random selection.