CreateAutoProvisioningGroup

The ID of the instance launch template associated with the auto provisioning group. You can call the DescribeLaunchTemplates operation to query available instance launch templates.

An auto provisioning group can be associated with only one instance launch template. But you can configure multiple extended configurations for the launch template through the LaunchTemplateConfig parameter.

The region ID of the auto provisioning group. You can call the DescribeRegions operation to query the latest region list.

The total target capacity of the auto provisioning group. The target capacity consists of the following three parts:

• The target capacity of pay-as-you-go instances specified by the PayAsYouGoTargetCapacity parameter
• The target capacity of preemptible instances specified by the SpotTargetCapacity parameter
• The supplemental capacity besides PayAsYouGoTargetCapacity and SpotTargetCapacity

The operation that you want to perform. Set this parameter to CreateAutoProvisioningGroup.

The name of the auto provisioning group to be created. It must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).

The type of the auto provisioning group. Valid values:

• request: One-time delivery. After the auto provisioning group is started, it only attempts to create an instance cluster once. If the cluster fails to be created, the group does not try again.
• maintain: The continuous delivery and maintain capacity type. After the auto provisioning group is started, it continuously attempts to create and maintain the instance cluster. The auto provisioning group compares the real-time and target capacity of the cluster. If the cluster does not meet the target capacity, the group will create instances until the cluster meets the target capacity.

Default value: maintain

The type of supplemental instances. When the total value of PayAsYouGoTargetCapacity and SpotTargetCapacity is smaller than the value of TotalTargetCapacity, the auto provisioning group will create instances of the specified type to meet the capacity requirements. Valid values:

• PayAsYouGo: Pay-as-you-go instances.
• Spot: Preemptible instances.

Default value: Spot

The description of the auto provisioning group.

The shutdown policy for excess preemptible instances followed when the capacity of the auto provisioning group exceeds the target capacity. Valid values:

• no-termination: Excess preemptible instances are not shut down.
• termination: Excess preemptible instances are to be shut down. The action to be performed on these shutdown instances is specified by the SpotInstanceInterruptionBehavior parameter.

Default value: no-termination

The instance type of the Nth extended configurations of the launch template.

The maximum price of the instance type specified in the Nth extended configurations of the launch template.

The priority of the instance type specified in the Nth extended configurations of the launch template. A value of 0 indicates the highest priority.

The ID of the VSwitch in the Nth extended configurations of the launch template.

The weight of the instance type specified in the Nth extended configurations of the launch template.

The weight is calculated based on the computing power of a specified instance type and the minimum computing power of a single node of the cluster. A greater weight indicates that the instance has more computing power, and as a result fewer instances are required.

For example, when the minimum computing power of a single node is 8 vCPUs and 60 GiB of memory, the weight of the instance type with 8 vCPUs and 60 GiB of memory is 1, and the weight of the instance type with 16 vCPUs and 120 GiB of memory is 2.

The version of the instance launch template associated with the auto provisioning group. You can call the DescribeLaunchTemplateVersions operation to query the versions of available instance launch templates.

The global maximum price for preemptible instances in the auto provisioning group. If both the MaxSpotPrice and LaunchTemplateConfig.N.MaxPrice parameters are specified, the maximum price is the lower value of the two.

The scale-out policy for pay-as-you-go instances. Valid values:

• lowest-price: The cost optimization policy the auto provisioning group follows to select instance types of the lowest cost to create instances.
• prioritized: The priority-based policy the auto provisioning group follows to create instances. The priority of an instance type is specified by the LaunchTemplateConfig.N.Priority parameter.

Default value: lowest-price

The target capacity of pay-as-you-go instances in the auto provisioning group.

The scale-out policy for preemptible instances. Valid values:

• lowest-price: The cost optimization policy the auto provisioning group follows to select instance types of the lowest cost to create instances.
• diversified: The distribution balancing policy the auto provisioning group follows to evenly create instances across zones specified in multiple extended template configurations.

Default value: lowest-price

The default behavior after preemptible instances are shut down. Value values:

• stop: stops preemptible instances.
• terminate: releases preemptible instances.

Default value: stop

This parameter takes effect when the SpotAllocationStrategy parameter is set to lowest-price. The auto provisioning group selects instance types of the lowest cost to create instances.

The target capacity of preemptible instances in the auto provisioning group.

Specifies whether to release instances of the auto provisioning group. Valid values:

• true
• false

Default: false

The shutdown policy for preemptible instances when the auto provisioning group expires. Valid values:

• true: shuts down preemptible instances. The action to be performed on these shutdown instances is specified by the SpotInstanceInterruptionBehavior parameter.
• false: does not shut down preemptible instances.

Default: false

The time when the auto provisioning group is started. The period of time between this point in time and the point in time specified by the ValidUntil parameter is the effective time period of the auto provisioning group.

By default, an auto provisioning group is immediately started after creation.

The time when the auto provisioning group expires. The period of time between this point in time and the point in time specified by the ValidFrom parameter is the effective time period of the auto provisioning group.

By default, an auto provisioning group never expires.

The ID of the auto provisioning group.

The ID of the request.