AutoProvisioningGroupProps
Properties for defining a AutoProvisioningGroup.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ecs-autoprovisioninggroup
Initializer
using AlibabaCloud.SDK.ROS.CDK.Ecs;
new AutoProvisioningGroupProps {
object TotalTargetCapacity,
object AutoProvisioningGroupName = null,
object AutoProvisioningGroupType = null,
object CheckExecutionStatus = null,
object DataDiskConfig = null,
object DefaultTargetCapacityType = null,
object Description = null,
object ExcessCapacityTerminationPolicy = null,
object LaunchConfiguration = null,
object LaunchTemplateConfig = null,
object LaunchTemplateId = null,
object LaunchTemplateVersion = null,
object MaxSpotPrice = null,
object MinTargetCapacity = null,
object PayAsYouGoAllocationStrategy = null,
object PayAsYouGoTargetCapacity = null,
object ResourceGroupId = null,
object ResourcePoolOptions = null,
object SpotAllocationStrategy = null,
object SpotInstanceInterruptionBehavior = null,
object SpotInstancePoolsToUseCount = null,
object SpotTargetCapacity = null,
object SystemDiskConfig = null,
object TerminateInstances = null,
object TerminateInstancesWithExpiration = null,
object ValidFrom = null,
object ValidUntil = null
};
Properties
| Name | Type | Description |
|---|---|---|
TotalTargetCapacity | object | Property totalTargetCapacity: The total target capacity of the auto provisioning group. |
AutoProvisioningGroupName | object | Property autoProvisioningGroupName: The name of the auto provisioning group to be created. |
AutoProvisioningGroupType | object | Property autoProvisioningGroupType: The delivery type of the auto provisioning group. |
CheckExecutionStatus | object | Property checkExecutionStatus: Whether check execution status. |
DataDiskConfig | object | Property dataDiskConfig: List of instance data disk information. |
DefaultTargetCapacityType | object | Property defaultTargetCapacityType: Specifies the billing method for the capacity difference when the sum of PayAsYouGoTargetCapacity and SpotTargetCapacity is less than TotalTargetCapacity. |
Description | object | Property description: The description of the auto provisioning group. |
ExcessCapacityTerminationPolicy | object | Property excessCapacityTerminationPolicy: Specifies whether to release instances when the real-time capacity of the auto provisioning group exceeds the target capacity and scale-in is triggered. |
LaunchConfiguration | object | Property launchConfiguration:. |
LaunchTemplateConfig | object | Property launchTemplateConfig:. |
LaunchTemplateId | object | Property launchTemplateId: The ID of the instance launch template associated with the auto provisioning group. |
LaunchTemplateVersion | object | Property launchTemplateVersion: The version of the launch template associated with the auto provisioning group. |
MaxSpotPrice | object | Property maxSpotPrice: The global maximum price for preemptible instances in the auto provisioning group. |
MinTargetCapacity | object | Property minTargetCapacity: The target minimum capacity of the elastic supply group. |
PayAsYouGoAllocationStrategy | object | Property payAsYouGoAllocationStrategy: The scale-out policy for pay-as-you-go instances. |
PayAsYouGoTargetCapacity | object | Property payAsYouGoTargetCapacity: The target capacity for pay-as-you-go instances in the auto provisioning group. |
ResourceGroupId | object | Property resourceGroupId: The resource group ID. |
ResourcePoolOptions | object | Property resourcePoolOptions: Resource pooling policy to use when creating an instance. |
SpotAllocationStrategy | object | Property spotAllocationStrategy: The strategy for creating spot instances. |
SpotInstanceInterruptionBehavior | object | Property spotInstanceInterruptionBehavior: The behavior when a spot instance is interrupted. |
SpotInstancePoolsToUseCount | object | Property spotInstancePoolsToUseCount: Takes effect only when SpotAllocationStrategy is set to lowest-price. |
SpotTargetCapacity | object | Property spotTargetCapacity: The target capacity for spot instances in the auto provisioning group. |
SystemDiskConfig | object | Property systemDiskConfig: List of instance system disk information. |
TerminateInstances | object | Property terminateInstances: Specifies whether to release instances in the group when you delete the auto provisioning group. |
TerminateInstancesWithExpiration | object | Property terminateInstancesWithExpiration: Specifies whether to release instances in the group when the auto provisioning group expires. |
ValidFrom | object | Property validFrom: The start time of the auto provisioning group. |
ValidUntil | object | Property validUntil: The expiration time of the auto provisioning group. |
TotalTargetCapacityRequired
public object TotalTargetCapacity { get; set; }
- Type: object
Property totalTargetCapacity: The total target capacity of the auto provisioning group.
Valid values: Positive integers. The total capacity must be greater than or equal to the sum of PayAsYouGoTargetCapacity (target capacity for pay-as-you-go instances) and SpotTargetCapacity (target capacity for spot instances).
AutoProvisioningGroupNameOptional
public object AutoProvisioningGroupName { get; set; }
- Type: object
Property autoProvisioningGroupName: 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 (-).
AutoProvisioningGroupTypeOptional
public object AutoProvisioningGroupType { get; set; }
- Type: object
Property autoProvisioningGroupType: The delivery type of the auto provisioning group.
Valid values:
- request: One-time asynchronous delivery. The group delivers the instance cluster only at startup. If scheduling fails, no retry occurs.
- instant: One-time synchronous delivery. The group creates instances synchronously at startup and returns the list of successfully created instances and reasons for failures in the response.
- maintain: Continuous provisioning. The group attempts to deliver the instance cluster at startup and monitors real-time capacity. If the target capacity is not met, it continues creating ECS instances. Default value: maintain.
CheckExecutionStatusOptional
public object CheckExecutionStatus { get; set; }
- Type: object
Property checkExecutionStatus: Whether check execution status.
If set true, ROS will check the state of AutoProvisioningGroup to be fulfilled. Otherwise ROS will regard AutoProvisioningGroup create failed.
DataDiskConfigOptional
public object DataDiskConfig { get; set; }
- Type: object
Property dataDiskConfig: List of instance data disk information.
DefaultTargetCapacityTypeOptional
public object DefaultTargetCapacityType { get; set; }
- Type: object
Property defaultTargetCapacityType: Specifies the billing method for the capacity difference when the sum of PayAsYouGoTargetCapacity and SpotTargetCapacity is less than TotalTargetCapacity.
Valid values:
- PayAsYouGo: Pay-as-you-go instances.
- Spot: Spot instances. Default value: Spot.
DescriptionOptional
public object Description { get; set; }
- Type: object
Property description: The description of the auto provisioning group.
ExcessCapacityTerminationPolicyOptional
public object ExcessCapacityTerminationPolicy { get; set; }
- Type: object
Property excessCapacityTerminationPolicy: Specifies whether to release instances when the real-time capacity of the auto provisioning group exceeds the target capacity and scale-in is triggered.
Valid values:
- termination: Releases scaled-in instances.
- no-termination: Only removes scaled-in instances from the auto provisioning group. Default value: no-termination.
LaunchConfigurationOptional
public object LaunchConfiguration { get; set; }
- Type: object
Property launchConfiguration:.
LaunchTemplateConfigOptional
public object LaunchTemplateConfig { get; set; }
- Type: object
Property launchTemplateConfig:.
LaunchTemplateIdOptional
public object LaunchTemplateId { get; set; }
- Type: object
Property launchTemplateId: 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.
LaunchTemplateVersionOptional
public object LaunchTemplateVersion { get; set; }
- Type: object
Property launchTemplateVersion: The version of the launch template associated with the auto provisioning group.
Call DescribeLaunchTemplateVersions to query available launch template versions. Default value: The default version of the launch template.
MaxSpotPriceOptional
public object MaxSpotPrice { get; set; }
- Type: object
Property maxSpotPrice: 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.
MinTargetCapacityOptional
public object MinTargetCapacity { get; set; }
- Type: object
Property minTargetCapacity: The target minimum capacity of the elastic supply group.
Value range: Positive integer. Once you have set this parameter, note that: Only create one-time synchronous delivery type elastic supply group (AutoProvisioningGroupType = instant), the parameters to take effect. If the inventory of instances in the current domain is less than this value, the call to the interface will fail and no instance will be created. If the instance inventory in the current domain is greater than the parameter value, the instance is created normally according to the other parameter values that have been set.
PayAsYouGoAllocationStrategyOptional
public object PayAsYouGoAllocationStrategy { get; set; }
- Type: object
Property payAsYouGoAllocationStrategy: 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
PayAsYouGoTargetCapacityOptional
public object PayAsYouGoTargetCapacity { get; set; }
- Type: object
Property payAsYouGoTargetCapacity: The target capacity for pay-as-you-go instances in the auto provisioning group.
Valid values: Integers less than or equal to the value of TotalTargetCapacity.
ResourceGroupIdOptional
public object ResourceGroupId { get; set; }
- Type: object
Property resourceGroupId: The resource group ID.
ResourcePoolOptionsOptional
public object ResourcePoolOptions { get; set; }
- Type: object
Property resourcePoolOptions: Resource pooling policy to use when creating an instance.
Once you have set this parameter, note that: This parameter only applies if a pay-as-you-go instance is created. Only create one-time synchronous delivery type elastic supply group (AutoProvisioningGroupType = instant), the parameters to take effect.
SpotAllocationStrategyOptional
public object SpotAllocationStrategy { get; set; }
- Type: object
Property spotAllocationStrategy: The strategy for creating spot instances.
Valid values:
- lowest-price: Cost optimization strategy. Selects the instance type with the lowest price.
- diversified: Balanced zone distribution strategy. Creates instances across the zones specified in the launch template configurations and distributes them evenly.
- capacity-optimized: Capacity optimization strategy. Selects the optimal instance type and zone based on inventory availability. Default value: lowest-price.
SpotInstanceInterruptionBehaviorOptional
public object SpotInstanceInterruptionBehavior { get; set; }
- Type: object
Property spotInstanceInterruptionBehavior: The behavior when a spot instance is interrupted.
Valid values:
- stop: Stops the instance.
- terminate: Releases the instance. Default value: terminate.
SpotInstancePoolsToUseCountOptional
public object SpotInstancePoolsToUseCount { get; set; }
- Type: object
Property spotInstancePoolsToUseCount: Takes effect only when SpotAllocationStrategy is set to lowest-price.
Specifies the number of lowest-priced instance types from which the auto provisioning group creates instances. Valid values: Less than the value of N in LaunchTemplateConfig.N.
SpotTargetCapacityOptional
public object SpotTargetCapacity { get; set; }
- Type: object
Property spotTargetCapacity: The target capacity for spot instances in the auto provisioning group.
Valid values: Integers less than or equal to the value of TotalTargetCapacity.
SystemDiskConfigOptional
public object SystemDiskConfig { get; set; }
- Type: object
Property systemDiskConfig: List of instance system disk information.
TerminateInstancesOptional
public object TerminateInstances { get; set; }
- Type: object
Property terminateInstances: Specifies whether to release instances in the group when you delete the auto provisioning group.
Valid values:
- true: Releases instances in the group.
- false: Retains instances in the group. Default value: false.
TerminateInstancesWithExpirationOptional
public object TerminateInstancesWithExpiration { get; set; }
- Type: object
Property terminateInstancesWithExpiration: Specifies whether to release instances in the group when the auto provisioning group expires.
Valid values:
- true: Releases instances in the group.
- false: Only removes instances from the auto provisioning group. Default value: false.
ValidFromOptional
public object ValidFrom { get; set; }
- Type: object
Property validFrom: The start time of the auto provisioning group.
Used together with ValidUntil to define the validity period. Specify the time in ISO 8601 format using UTC+0 time. Format: yyyy-MM-ddTHH:mm:ssZ. Default value: The timestamp when the API call takes effect immediately.
ValidUntilOptional
public object ValidUntil { get; set; }
- Type: object
Property validUntil: The expiration time of the auto provisioning group.
Used together with ValidFrom to define the validity period. Specify the time in ISO 8601 format using UTC+0 time. Format: yyyy-MM-ddTHH:mm:ssZ. Default value: 2099-12-31T23:59:59Z.