InstanceGroup

• Implements: IInstanceGroup

This class encapsulates and extends the ROS resource type ALIYUN::ECS::InstanceGroup.

Initializers

import ros_cdk_ecs
ros_cdk_ecs.InstanceGroup(
  scope: Construct,
  id: str,
  instance_type: typing.Union[str, IResolvable],
  max_amount: typing.Union[typing.Union[int, float], IResolvable],
  affinity: typing.Union[str, IResolvable] = None,
  allocate_public_ip: typing.Union[bool, IResolvable] = None,
  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,
  cpu_options: typing.Union[IResolvable, CpuOptionsProperty] = None,
  credit_specification: typing.Union[str, IResolvable] = None,
  dedicated_host_id: typing.Union[str, IResolvable] = None,
  deletion_force: typing.Union[bool, IResolvable] = None,
  deletion_protection: typing.Union[bool, IResolvable] = None,
  deployment_set_group_no: typing.Union[typing.Union[int, float], 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_name: typing.Union[str, IResolvable] = None,
  host_names: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  hpc_cluster_id: typing.Union[str, IResolvable] = None,
  http_endpoint: typing.Union[str, IResolvable] = None,
  http_tokens: typing.Union[str, IResolvable] = None,
  image_family: typing.Union[str, IResolvable] = None,
  image_id: typing.Union[str, IResolvable] = None,
  image_options: typing.Union[IResolvable, ImageOptionsProperty] = None,
  instance_charge_type: typing.Union[str, IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  internet_charge_type: typing.Union[str, IResolvable] = None,
  internet_max_bandwidth_out: typing.Union[typing.Union[int, float], IResolvable] = None,
  io_optimized: typing.Union[str, 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,
  network_interface_queue_number: typing.Union[typing.Union[int, float], IResolvable] = None,
  network_options: typing.Union[IResolvable, NetworkOptionsProperty] = None,
  network_type: typing.Union[str, IResolvable] = 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,
  private_ip_address: typing.Union[str, IResolvable] = None,
  private_pool_options: typing.Union[IResolvable, PrivatePoolOptionsProperty] = None,
  ram_role_name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  scheduler_options: typing.Union[IResolvable, SchedulerOptionsProperty] = None,
  security_enhancement_strategy: 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_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  spot_interruption_behavior: typing.Union[str, IResolvable] = None,
  spot_price_limit: typing.Union[str, IResolvable] = None,
  spot_strategy: typing.Union[str, IResolvable] = None,
  storage_set_id: typing.Union[str, IResolvable] = None,
  storage_set_partition_number: typing.Union[typing.Union[int, float], IResolvable] = None,
  subscription_deletion_force: typing.Union[bool, 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_performance_level: typing.Union[str, IResolvable] = None,
  system_disk_provisioned_iops: typing.Union[typing.Union[int, float], IResolvable] = None,
  system_disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  system_disk_storage_cluster_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  tenancy: typing.Union[str, IResolvable] = None,
  unique_suffix: typing.Union[bool, IResolvable] = None,
  update_policy: typing.Union[str, IResolvable] = None,
  use_additional_service: typing.Union[bool, IResolvable] = None,
  user_data: typing.Union[str, IResolvable] = None,
  vpc_id: typing.Union[str, IResolvable] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  zone_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

instance_type^Required

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

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

max_amount^Required

• 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.

affinity^Optional

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

Property affinity: Specifies whether to associate the instance on a dedicated host with the dedicated host.

Valid values:

• default: does not associate the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance is automatically deployed to another dedicated host in the automatic deployment resource pool if the available resources of the original dedicated host are insufficient.
• host: associates the ECS instance with the dedicated host. When you start an instance that was stopped in economical mode, the instance remains on the original dedicated host. If the available resources of the original dedicated host are insufficient, the instance cannot start. Default value: default.

allocate_public_ip^Optional

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

Property allocatePublicIp: The public ip for ecs instance, if properties is true, will allocate public ip.

If property InternetMaxBandwidthOut set to 0, it will not assign public ip.

auto_release_time^Optional

• 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_renew^Optional

• 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_period^Optional

• 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.

cpu_options^Optional

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

Property cpuOptions: Cpu options.

credit_specification^Optional

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

Property creditSpecification: The performance mode of the burstable instance.

Valid values:

• Standard: the standard mode.
• Unlimited: the unlimited mode.

dedicated_host_id^Optional

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

Property dedicatedHostId: The ID of the dedicated host.

You can call the DescribeDedicatedHosts operation to query the list of dedicated host IDs.

Spot instances cannot be created on dedicated hosts. If you specify DedicatedHostId, SpotStrategy and SpotPriceLimit are automatically ignored.

deletion_force^Optional

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

Property deletionForce: Whether force delete the instance.

Default value is false.

deletion_protection^Optional

• 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_group_no^Optional

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

Property deploymentSetGroupNo: The number of the deployment set group to which to deploy the instance.

If the deployment set specified by DeploymentSetId uses the high availability group strategy (AvailabilityGroup), you can use DeploymentSetGroupNo to specify a deployment set group in the deployment set. Valid values: 1 to 7.

deployment_set_id^Optional

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

Property deploymentSetId: Deployment set ID.

The change of the property does not affect existing instances.

description^Optional

• 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_mappings^Optional

• 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_mappings^Optional

• 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_name^Optional

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

Property hostName: Host name of created ecs instance.

at least 2 characters, and '.' '-' Is not the first and last characters as hostname, not continuous use. Windows platform can be up to 15 characters, allowing letters (without limiting case), numbers and '-', and does not support the number of points, not all is digital ('.').Other (Linux, etc.) platform up to 64 characters, allowing support number multiple points for the period between the points, each permit letters (without limiting case), numbers and '-' components. Support to use the regular expression to set the different instance name for each ECS instance. HostName could be specified as 'name_prefix[begin_number,bits]name_suffix', such as 'host[123,4]tail'. If you creates 3 instances with hostname 'host[123,4]tail', all the host names of instances are host0123tail, host0124tail, host0125tail. 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. The host name is specified by regular expression works after restart instance manually.

host_names^Optional

• 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_id^Optional

• 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.

http_endpoint^Optional

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

Property httpEndpoint: Specifies whether the access channel is enabled for instance metadata.

Valid values:

• enabled
• disabled Default value: enabled.

http_tokens^Optional

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

Property httpTokens: Specifies whether the security hardening mode (IMDSv2) is forcefully used to access instance metadata.

Valid values:

• optional: does not forcefully use the security-enhanced mode (IMDSv2).
• required: forcefully uses the security-enhanced mode (IMDSv2). After you set this parameter to required, you cannot access instance metadata in normal mode. Default value: optional.

image_family^Optional

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

Property imageFamily: The name of the image family.

You can set this parameter to obtain the latest available custom image from the specified image family to create the instance.

• ImageFamily must be empty if ImageId is specified.
• ImageFamily can be specified if ImageId is not specified.

image_id^Optional

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

Property imageId: The image ID.

def to_string() -> str

def synthesize(
  session: ISynthesisSession
) -> None

def add_condition(
  condition: RosCondition
) -> None

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

def add_dependency(
  resource: Resource
) -> None

def add_resource_desc(
  desc: str
) -> None

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

def fetch_condition() -> RosCondition

def fetch_dependency() -> typing.List[str]

def fetch_resource_desc() -> str

def get_att(
  name: str
) -> IResolvable

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

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

node: ConstructNode

env: IResourceEnvironment

ref: str

stack: Stack

resource: RosResource

attr_host_names: typing.Union[str, IResolvable]

attr_inner_ips: typing.Union[str, IResolvable]

attr_instance_ids: typing.Union[str, IResolvable]

attr_ipv6_addresses: typing.Union[str, IResolvable]

attr_ipv6_address_ids: typing.Union[str, IResolvable]

attr_order_id: typing.Union[str, IResolvable]

attr_private_ips: typing.Union[str, IResolvable]

attr_public_ips: typing.Union[str, IResolvable]

attr_zone_ids: typing.Union[str, IResolvable]

props: InstanceGroupProps