Skip to content

AutoProvisioningGroupProps

Properties for defining a AutoProvisioningGroup.

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

Initializer 

import { AutoProvisioningGroupProps } from '@alicloud/ros-cdk-ecs'
const autoProvisioningGroupProps: AutoProvisioningGroupProps = { ... }

Properties

Name Type Description
totalTargetCapacity string | @alicloud/ros-cdk-core.IResolvable Property totalTargetCapacity: The total target capacity of the auto provisioning group.
autoProvisioningGroupName string | @alicloud/ros-cdk-core.IResolvable Property autoProvisioningGroupName: The name of the auto provisioning group to be created.
autoProvisioningGroupType string | @alicloud/ros-cdk-core.IResolvable Property autoProvisioningGroupType: The type of the auto provisioning group.
checkExecutionStatus boolean | @alicloud/ros-cdk-core.IResolvable Property checkExecutionStatus: Whether check execution status.
defaultTargetCapacityType string | @alicloud/ros-cdk-core.IResolvable Property defaultTargetCapacityType: The type of supplemental instances.
description string | @alicloud/ros-cdk-core.IResolvable Property description: The description of the auto provisioning group.
excessCapacityTerminationPolicy string | @alicloud/ros-cdk-core.IResolvable Property excessCapacityTerminationPolicy: The shutdown policy for excess preemptible instances followed when the capacity of the auto provisioning group exceeds the target capacity.
launchConfiguration @alicloud/ros-cdk-core.IResolvable | LaunchConfigurationProperty Property launchConfiguration:.
launchTemplateConfig @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | LaunchTemplateConfigProperty[] Property launchTemplateConfig:.
launchTemplateId string | @alicloud/ros-cdk-core.IResolvable Property launchTemplateId: The ID of the instance launch template associated with the auto provisioning group.
launchTemplateVersion string | @alicloud/ros-cdk-core.IResolvable Property launchTemplateVersion: The version of the instance launch template associated with the auto provisioning group.
maxSpotPrice number | @alicloud/ros-cdk-core.IResolvable Property maxSpotPrice: The global maximum price for preemptible instances in the auto provisioning group.
payAsYouGoAllocationStrategy string | @alicloud/ros-cdk-core.IResolvable Property payAsYouGoAllocationStrategy: The scale-out policy for pay-as-you-go instances.
payAsYouGoTargetCapacity string | @alicloud/ros-cdk-core.IResolvable Property payAsYouGoTargetCapacity: The target capacity of pay-as-you-go instances in the auto provisioning group.
spotAllocationStrategy string | @alicloud/ros-cdk-core.IResolvable Property spotAllocationStrategy: The scale-out policy for preemptible instances.
spotInstanceInterruptionBehavior string | @alicloud/ros-cdk-core.IResolvable Property spotInstanceInterruptionBehavior: The default behavior after preemptible instances are shut down.
spotInstancePoolsToUseCount number | @alicloud/ros-cdk-core.IResolvable Property spotInstancePoolsToUseCount: This parameter takes effect when the SpotAllocationStrategy parameter is set to lowest-price.
spotTargetCapacity string | @alicloud/ros-cdk-core.IResolvable Property spotTargetCapacity: The target capacity of preemptible instances in the auto provisioning group.
terminateInstances boolean | @alicloud/ros-cdk-core.IResolvable Property terminateInstances: Specifies whether to release instances of the auto provisioning group.
terminateInstancesWithExpiration boolean | @alicloud/ros-cdk-core.IResolvable Property terminateInstancesWithExpiration: The shutdown policy for preemptible instances when the auto provisioning group expires.
validFrom string | @alicloud/ros-cdk-core.IResolvable Property validFrom: The time when the auto provisioning group is started.
validUntil string | @alicloud/ros-cdk-core.IResolvable Property validUntil: The time when the auto provisioning group expires.

totalTargetCapacityRequired 

public readonly totalTargetCapacity: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property totalTargetCapacity: 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

autoProvisioningGroupNameOptional 

public readonly autoProvisioningGroupName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly autoProvisioningGroupType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property autoProvisioningGroupType: 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

checkExecutionStatusOptional 

public readonly checkExecutionStatus: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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.

defaultTargetCapacityTypeOptional 

public readonly defaultTargetCapacityType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property defaultTargetCapacityType: 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

descriptionOptional 

public readonly description: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the auto provisioning group.

excessCapacityTerminationPolicyOptional 

public readonly excessCapacityTerminationPolicy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property excessCapacityTerminationPolicy: 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

launchConfigurationOptional 

public readonly launchConfiguration: IResolvable | LaunchConfigurationProperty;

Property launchConfiguration:.

launchTemplateConfigOptional 

public readonly launchTemplateConfig: IResolvable | IResolvable | LaunchTemplateConfigProperty[];

Property launchTemplateConfig:.

launchTemplateIdOptional 

public readonly launchTemplateId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly launchTemplateVersion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

maxSpotPriceOptional 

public readonly maxSpotPrice: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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.

payAsYouGoAllocationStrategyOptional 

public readonly payAsYouGoAllocationStrategy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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 readonly payAsYouGoTargetCapacity: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

spotAllocationStrategyOptional 

public readonly spotAllocationStrategy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property spotAllocationStrategy: 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

spotInstanceInterruptionBehaviorOptional 

public readonly spotInstanceInterruptionBehavior: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property spotInstanceInterruptionBehavior: The default behavior after preemptible instances are shut down.

Value values: stop: stops preemptible instances. terminate: releases preemptible instances. Default value: stop

spotInstancePoolsToUseCountOptional 

public readonly spotInstancePoolsToUseCount: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

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

spotTargetCapacityOptional 

public readonly spotTargetCapacity: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

terminateInstancesOptional 

public readonly terminateInstances: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property terminateInstances: Specifies whether to release instances of the auto provisioning group.

Valid values: true false Default: false

terminateInstancesWithExpirationOptional 

public readonly terminateInstancesWithExpiration: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property terminateInstancesWithExpiration: 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

validFromOptional 

public readonly validFrom: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

validUntilOptional 

public readonly validUntil: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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