AutoProvisioningGroup

• Implements: IAutoProvisioningGroup

This class encapsulates and extends the ROS resource type ALIYUN::ECS::AutoProvisioningGroup.

Initializers

import com.aliyun.ros.cdk.ecs.AutoProvisioningGroup;
AutoProvisioningGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .totalTargetCapacity(java.lang.String)
    .totalTargetCapacity(IResolvable)
//  .autoProvisioningGroupName(java.lang.String)
//  .autoProvisioningGroupName(IResolvable)
//  .autoProvisioningGroupType(java.lang.String)
//  .autoProvisioningGroupType(IResolvable)
//  .checkExecutionStatus(java.lang.Boolean)
//  .checkExecutionStatus(IResolvable)
//  .dataDiskConfig(IResolvable)
//  .dataDiskConfig(java.util.List<IResolvable)
//  .dataDiskConfig(DataDiskConfigProperty>)
//  .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)
//  .minTargetCapacity(java.lang.String)
//  .minTargetCapacity(IResolvable)
//  .payAsYouGoAllocationStrategy(java.lang.String)
//  .payAsYouGoAllocationStrategy(IResolvable)
//  .payAsYouGoTargetCapacity(java.lang.String)
//  .payAsYouGoTargetCapacity(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .resourcePoolOptions(IResolvable)
//  .resourcePoolOptions(ResourcePoolOptionsProperty)
//  .spotAllocationStrategy(java.lang.String)
//  .spotAllocationStrategy(IResolvable)
//  .spotInstanceInterruptionBehavior(java.lang.String)
//  .spotInstanceInterruptionBehavior(IResolvable)
//  .spotInstancePoolsToUseCount(java.lang.Number)
//  .spotInstancePoolsToUseCount(IResolvable)
//  .spotTargetCapacity(java.lang.String)
//  .spotTargetCapacity(IResolvable)
//  .systemDiskConfig(IResolvable)
//  .systemDiskConfig(java.util.List<IResolvable)
//  .systemDiskConfig(SystemDiskConfigProperty>)
//  .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();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

totalTargetCapacity^Required

• Type: java.lang.String OR com.aliyun.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

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

autoProvisioningGroupType^Optional

• Type: java.lang.String OR com.aliyun.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

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

dataDiskConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDataDiskConfigProperty>

Property dataDiskConfig: List of instance data disk information.

defaultTargetCapacityType^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the auto provisioning group.

excessCapacityTerminationPolicy^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: com.aliyun.ros.cdk.core.IResolvable OR LaunchConfigurationProperty

Property launchConfiguration:.

launchTemplateConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListLaunchTemplateConfigProperty>

Property launchTemplateConfig:.

launchTemplateId^Optional

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

launchTemplateVersion^Optional

• Type: java.lang.String OR com.aliyun.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

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

minTargetCapacity^Optional

• Type: java.lang.String OR com.aliyun.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

• 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

payAsYouGoTargetCapacity^Optional

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The resource group ID.

resourcePoolOptions^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR 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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.Number OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListSystemDiskConfigProperty>

Property systemDiskConfig: List of instance system disk information.

terminateInstances^Optional

• Type: java.lang.Boolean OR com.aliyun.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

• Type: java.lang.Boolean OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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

• Type: java.lang.String OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ecs.AutoProvisioningGroup;
AutoProvisioningGroup.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrAutoProvisioningGroupId^Required

public java.lang.Object getAttrAutoProvisioningGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AutoProvisioningGroupId: The ID of the auto provisioning group.

attrAutoProvisioningGroupName^Required

public java.lang.Object getAttrAutoProvisioningGroupName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AutoProvisioningGroupName: The name of the auto provisioning group.

props^Required

public AutoProvisioningGroupProps getProps();

• Type: AutoProvisioningGroupProps