Skip to content

AutoProvisioningGroupProps

Properties for defining a AutoProvisioningGroup.

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

Initializer 

import com.aliyun.ros.cdk.ecs.AutoProvisioningGroupProps;
AutoProvisioningGroupProps.builder()
    .totalTargetCapacity(java.lang.String)
    .totalTargetCapacity(IResolvable)
//  .autoProvisioningGroupName(java.lang.String)
//  .autoProvisioningGroupName(IResolvable)
//  .autoProvisioningGroupType(java.lang.String)
//  .autoProvisioningGroupType(IResolvable)
//  .checkExecutionStatus(java.lang.Boolean)
//  .checkExecutionStatus(IResolvable)
//  .defaultTargetCapacityType(java.lang.String)
//  .defaultTargetCapacityType(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .excessCapacityTerminationPolicy(java.lang.String)
//  .excessCapacityTerminationPolicy(IResolvable)
//  .launchConfiguration(IResolvable)
//  .launchConfiguration(LaunchConfigurationProperty)
//  .launchTemplateConfig(IResolvable)
//  .launchTemplateConfig(java.util.List<IResolvable)
//  .launchTemplateConfig(LaunchTemplateConfigProperty>)
//  .launchTemplateId(java.lang.String)
//  .launchTemplateId(IResolvable)
//  .launchTemplateVersion(java.lang.String)
//  .launchTemplateVersion(IResolvable)
//  .maxSpotPrice(java.lang.Number)
//  .maxSpotPrice(IResolvable)
//  .payAsYouGoAllocationStrategy(java.lang.String)
//  .payAsYouGoAllocationStrategy(IResolvable)
//  .payAsYouGoTargetCapacity(java.lang.String)
//  .payAsYouGoTargetCapacity(IResolvable)
//  .spotAllocationStrategy(java.lang.String)
//  .spotAllocationStrategy(IResolvable)
//  .spotInstanceInterruptionBehavior(java.lang.String)
//  .spotInstanceInterruptionBehavior(IResolvable)
//  .spotInstancePoolsToUseCount(java.lang.Number)
//  .spotInstancePoolsToUseCount(IResolvable)
//  .spotTargetCapacity(java.lang.String)
//  .spotTargetCapacity(IResolvable)
//  .terminateInstances(java.lang.Boolean)
//  .terminateInstances(IResolvable)
//  .terminateInstancesWithExpiration(java.lang.Boolean)
//  .terminateInstancesWithExpiration(IResolvable)
//  .validFrom(java.lang.String)
//  .validFrom(IResolvable)
//  .validUntil(java.lang.String)
//  .validUntil(IResolvable)
    .build();

Properties

Name Type Description
totalTargetCapacity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property totalTargetCapacity: The total target capacity of the auto provisioning group.
autoProvisioningGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoProvisioningGroupName: The name of the auto provisioning group to be created.
autoProvisioningGroupType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property autoProvisioningGroupType: The type of the auto provisioning group.
checkExecutionStatus java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property checkExecutionStatus: Whether check execution status.
defaultTargetCapacityType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property defaultTargetCapacityType: The type of supplemental instances.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the auto provisioning group.
excessCapacityTerminationPolicy java.lang.String OR com.aliyun.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 com.aliyun.ros.cdk.core.IResolvable OR LaunchConfigurationProperty Property launchConfiguration:.
launchTemplateConfig com.aliyun.ros.cdk.core.IResolvable OR java.util.ListLaunchTemplateConfigProperty> Property launchTemplateConfig:.
launchTemplateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property launchTemplateId: The ID of the instance launch template associated with the auto provisioning group.
launchTemplateVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property launchTemplateVersion: The version of the instance launch template associated with the auto provisioning group.
maxSpotPrice java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxSpotPrice: The global maximum price for preemptible instances in the auto provisioning group.
payAsYouGoAllocationStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payAsYouGoAllocationStrategy: The scale-out policy for pay-as-you-go instances.
payAsYouGoTargetCapacity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property payAsYouGoTargetCapacity: The target capacity of pay-as-you-go instances in the auto provisioning group.
spotAllocationStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spotAllocationStrategy: The scale-out policy for preemptible instances.
spotInstanceInterruptionBehavior java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spotInstanceInterruptionBehavior: The default behavior after preemptible instances are shut down.
spotInstancePoolsToUseCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property spotInstancePoolsToUseCount: This parameter takes effect when the SpotAllocationStrategy parameter is set to lowest-price.
spotTargetCapacity java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spotTargetCapacity: The target capacity of preemptible instances in the auto provisioning group.
terminateInstances java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property terminateInstances: Specifies whether to release instances of the auto provisioning group.
terminateInstancesWithExpiration java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property terminateInstancesWithExpiration: The shutdown policy for preemptible instances when the auto provisioning group expires.
validFrom java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property validFrom: The time when the auto provisioning group is started.
validUntil java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property validUntil: The time when the auto provisioning group expires.

totalTargetCapacityRequired 

public java.lang.Object getTotalTargetCapacity();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getAutoProvisioningGroupName();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getAutoProvisioningGroupType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getCheckExecutionStatus();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getDefaultTargetCapacityType();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the auto provisioning group.

excessCapacityTerminationPolicyOptional 

public java.lang.Object getExcessCapacityTerminationPolicy();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getLaunchConfiguration();

Property launchConfiguration:.

launchTemplateConfigOptional 

public java.lang.Object getLaunchTemplateConfig();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListLaunchTemplateConfigProperty>

Property launchTemplateConfig:.

launchTemplateIdOptional 

public java.lang.Object getLaunchTemplateId();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getLaunchTemplateVersion();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getMaxSpotPrice();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getPayAsYouGoAllocationStrategy();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getPayAsYouGoTargetCapacity();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

spotAllocationStrategyOptional 

public java.lang.Object getSpotAllocationStrategy();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSpotInstanceInterruptionBehavior();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSpotInstancePoolsToUseCount();
  • Type: java.lang.Number OR com.aliyun.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 java.lang.Object getSpotTargetCapacity();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

terminateInstancesOptional 

public java.lang.Object getTerminateInstances();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: true false Default: false

terminateInstancesWithExpirationOptional 

public java.lang.Object getTerminateInstancesWithExpiration();
  • Type: java.lang.Boolean OR com.aliyun.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 java.lang.Object getValidFrom();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getValidUntil();
  • Type: java.lang.String OR com.aliyun.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.