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

totalTargetCapacity^Required

public readonly totalTargetCapacity: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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

autoProvisioningGroupName^Optional

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 (-).

autoProvisioningGroupType^Optional

public readonly autoProvisioningGroupType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.

checkExecutionStatus^Optional

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.

dataDiskConfig^Optional

public readonly dataDiskConfig: IResolvable | IResolvable | DataDiskConfigProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DataDiskConfigProperty[]

Property dataDiskConfig: List of instance data disk information.

defaultTargetCapacityType^Optional

public readonly defaultTargetCapacityType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.

description^Optional

public readonly description: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: The description of the auto provisioning group.

excessCapacityTerminationPolicy^Optional

public readonly excessCapacityTerminationPolicy: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.

launchConfiguration^Optional

public readonly launchConfiguration: IResolvable | LaunchConfigurationProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | LaunchConfigurationProperty

Property launchConfiguration:.

launchTemplateConfig^Optional

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

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | LaunchTemplateConfigProperty[]

Property launchTemplateConfig:.

launchTemplateId^Optional

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.

launchTemplateVersion^Optional

public readonly launchTemplateVersion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.

maxSpotPrice^Optional

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.

minTargetCapacity^Optional

public readonly minTargetCapacity: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.

payAsYouGoAllocationStrategy^Optional

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

payAsYouGoTargetCapacity^Optional

public readonly payAsYouGoTargetCapacity: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The resource group ID.

resourcePoolOptions^Optional

public readonly resourcePoolOptions: IResolvable | ResourcePoolOptionsProperty;

• Type: @alicloud/ros-cdk-core.IResolvable | ResourcePoolOptionsProperty

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.

spotAllocationStrategy^Optional

public readonly spotAllocationStrategy: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.

spotInstanceInterruptionBehavior^Optional

public readonly spotInstanceInterruptionBehavior: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property spotInstanceInterruptionBehavior: The behavior when a spot instance is interrupted.

Valid values: - stop: Stops the instance. - terminate: Releases the instance. Default value: terminate.

spotInstancePoolsToUseCount^Optional

public readonly spotInstancePoolsToUseCount: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

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.

spotTargetCapacity^Optional

public readonly spotTargetCapacity: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.

systemDiskConfig^Optional

public readonly systemDiskConfig: IResolvable | IResolvable | SystemDiskConfigProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | SystemDiskConfigProperty[]

Property systemDiskConfig: List of instance system disk information.

terminateInstances^Optional

public readonly terminateInstances: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

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.

terminateInstancesWithExpiration^Optional

public readonly terminateInstancesWithExpiration: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

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.

validFrom^Optional

public readonly validFrom: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.

validUntil^Optional

public readonly validUntil: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

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.