Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ens-instance

Initializer 

import ros_cdk_ens
ros_cdk_ens.InstanceProps(
  data_disk_size: typing.Union[typing.Union[int, float], IResolvable],
  ens_region_id: typing.Union[str, IResolvable],
  image_id: typing.Union[str, IResolvable],
  instance_type: typing.Union[str, IResolvable],
  period: typing.Union[typing.Union[int, float], IResolvable],
  quantity: typing.Union[typing.Union[int, float], IResolvable],
  system_disk_size: typing.Union[typing.Union[int, float], IResolvable],
  auto_renew: typing.Union[str, IResolvable] = None,
  auto_renew_period: typing.Union[typing.Union[int, float], IResolvable] = None,
  host_name: typing.Union[str, IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  ip_type: typing.Union[str, IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  password: typing.Union[str, IResolvable] = None,
  payment_type: typing.Union[str, IResolvable] = None,
  private_ip_address: typing.Union[str, IResolvable] = None,
  unique_suffix: typing.Union[bool, IResolvable] = None,
  user_data: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None
)

Properties

Name Type Description
data_disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property dataDiskSize: Disk size of the system disk, range from 20 to 500 GB.
ens_region_id typing.Union[str, ros_cdk_core.IResolvable] Property ensRegionId: ENS Region Id.
image_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: Image ID to create ens instance.
instance_type typing.Union[str, ros_cdk_core.IResolvable] Property instanceType: ENS instance supported instance type, make sure it should be correct.
period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property period: Prepaid time period.
quantity typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property quantity: number of instances to create.
system_disk_size typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property systemDiskSize: Disk size of the system disk.
auto_renew typing.Union[str, ros_cdk_core.IResolvable] Property autoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.
auto_renew_period typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property autoRenewPeriod: The time period of auto renew.
host_name typing.Union[str, ros_cdk_core.IResolvable] Property hostName: The hostname of the instance.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: Instance name.
internet_charge_type typing.Union[str, ros_cdk_core.IResolvable] Property internetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.
ip_type typing.Union[str, ros_cdk_core.IResolvable] Property ipType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] Property keyPairName: SSH key pair name.
password typing.Union[str, ros_cdk_core.IResolvable] Property password: Password of created ens instance.
payment_type typing.Union[str, ros_cdk_core.IResolvable] Property paymentType: Payment Type.only support value Subscription.
private_ip_address typing.Union[str, ros_cdk_core.IResolvable] Property privateIpAddress: Private IP for the instance created.
unique_suffix typing.Union[bool, ros_cdk_core.IResolvable] Property uniqueSuffix: Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter when you create multiple instances at a time.
user_data typing.Union[str, ros_cdk_core.IResolvable] Property userData: User data to pass to instance.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The vSwitch Id to create ens instance.

data_disk_sizeRequired 

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

Property dataDiskSize: Disk size of the system disk, range from 20 to 500 GB.

If you specify with your own image, make sure the system disk size bigger than image size.

ens_region_idRequired 

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

Property ensRegionId: ENS Region Id.

image_idRequired 

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

Property imageId: Image ID to create ens instance.

instance_typeRequired 

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

Property instanceType: ENS instance supported instance type, make sure it should be correct.

periodRequired 

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. Default value is 1.

quantityRequired 

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

Property quantity: number of instances to create.

system_disk_sizeRequired 

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

Property systemDiskSize: Disk size of the system disk.

auto_renewOptional 

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

Property autoRenew: Whether renew the fee automatically?it could be True,FalseDefault value is False.

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.

it will take effect.It could be 1, 2, 3, 6, 12. Default value is 1.

host_nameOptional 

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

Property hostName: The hostname of the instance.

instance_nameOptional 

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

Property instanceName: Instance name.

internet_charge_typeOptional 

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

Property internetChargeType: Instance Charge type.it could be 95BandwidthByMonth, PayByBandwidth4thMonth.

ip_typeOptional 

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

Property ipType: ip type, It could be ipv4Andipv6,ipv4,ipv6.default value isi pv4.

key_pair_nameOptional 

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

Property keyPairName: SSH key pair name.

passwordOptional 

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

Property password: Password of created ens instance.

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

payment_typeOptional 

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

Property paymentType: Payment Type.only support value Subscription.

private_ip_addressOptional 

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

Property privateIpAddress: Private IP for the instance created.

unique_suffixOptional 

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

Property uniqueSuffix: Specifies whether to automatically append sequential suffixes to the hostnames specified by the HostName parameter and instance names specified by the InstanceName parameter when you create multiple instances at a time.

The sequential suffix ranges from 001 to 999. Valid values: true false Default value: false.

user_dataOptional 

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

Property userData: User data to pass to instance.

[1, 16KB] characters.User data should not be base64 encoded. If you want to pass base64 encoded string to the property, use function Fn::Base64Decode to decode the base64 string first.

v_switch_idOptional 

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

Property vSwitchId: The vSwitch Id to create ens instance.