commonMain.aws.sdk.kotlin.services.autoscaling.model.InstancesDistribution.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of autoscaling-jvm Show documentation
Show all versions of autoscaling-jvm Show documentation
The AWS SDK for Kotlin client for Auto Scaling
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.autoscaling.model
import aws.smithy.kotlin.runtime.SdkDsl
/**
* Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy.
*/
public class InstancesDistribution private constructor(builder: Builder) {
/**
* The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
*
* The following lists the valid values:
*
* ## lowest-price
* Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.
*
* ## prioritized
* You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.
*/
public val onDemandAllocationStrategy: kotlin.String? = builder.onDemandAllocationStrategy
/**
* The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.
*
* This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.
*
* Default: 0
*/
public val onDemandBaseCapacity: kotlin.Int? = builder.onDemandBaseCapacity
/**
* Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond `OnDemandBaseCapacity`. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.
*
* Default: 100
*/
public val onDemandPercentageAboveBaseCapacity: kotlin.Int? = builder.onDemandPercentageAboveBaseCapacity
/**
* The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
*
* The following lists the valid values:
*
* ## capacity-optimized
* Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use `capacity-optimized-prioritized`.
*
* ## capacity-optimized-prioritized
* You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to `prioritized`, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.
*
* ## lowest-price
* Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the `SpotInstancePools` property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity.
*
* ## price-capacity-optimized (recommended)
* The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.
*/
public val spotAllocationStrategy: kotlin.String? = builder.spotAllocationStrategy
/**
* The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the `SpotAllocationStrategy` is `lowest-price`. Value must be in the range of 1–20.
*
* Default: 2
*/
public val spotInstancePools: kotlin.Int? = builder.spotInstancePools
/**
* The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.
*
* If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.
*
* Valid Range: Minimum value of 0.001
*/
public val spotMaxPrice: kotlin.String? = builder.spotMaxPrice
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.autoscaling.model.InstancesDistribution = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("InstancesDistribution(")
append("onDemandAllocationStrategy=$onDemandAllocationStrategy,")
append("onDemandBaseCapacity=$onDemandBaseCapacity,")
append("onDemandPercentageAboveBaseCapacity=$onDemandPercentageAboveBaseCapacity,")
append("spotAllocationStrategy=$spotAllocationStrategy,")
append("spotInstancePools=$spotInstancePools,")
append("spotMaxPrice=$spotMaxPrice")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = onDemandAllocationStrategy?.hashCode() ?: 0
result = 31 * result + (onDemandBaseCapacity ?: 0)
result = 31 * result + (onDemandPercentageAboveBaseCapacity ?: 0)
result = 31 * result + (spotAllocationStrategy?.hashCode() ?: 0)
result = 31 * result + (spotInstancePools ?: 0)
result = 31 * result + (spotMaxPrice?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as InstancesDistribution
if (onDemandAllocationStrategy != other.onDemandAllocationStrategy) return false
if (onDemandBaseCapacity != other.onDemandBaseCapacity) return false
if (onDemandPercentageAboveBaseCapacity != other.onDemandPercentageAboveBaseCapacity) return false
if (spotAllocationStrategy != other.spotAllocationStrategy) return false
if (spotInstancePools != other.spotInstancePools) return false
if (spotMaxPrice != other.spotMaxPrice) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.autoscaling.model.InstancesDistribution = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
*
* The following lists the valid values:
*
* ## lowest-price
* Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.
*
* ## prioritized
* You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.
*/
public var onDemandAllocationStrategy: kotlin.String? = null
/**
* The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.
*
* This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.
*
* Default: 0
*/
public var onDemandBaseCapacity: kotlin.Int? = null
/**
* Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond `OnDemandBaseCapacity`. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.
*
* Default: 100
*/
public var onDemandPercentageAboveBaseCapacity: kotlin.Int? = null
/**
* The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
*
* The following lists the valid values:
*
* ## capacity-optimized
* Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use `capacity-optimized-prioritized`.
*
* ## capacity-optimized-prioritized
* You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to `prioritized`, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.
*
* ## lowest-price
* Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the `SpotInstancePools` property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity.
*
* ## price-capacity-optimized (recommended)
* The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.
*/
public var spotAllocationStrategy: kotlin.String? = null
/**
* The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the `SpotAllocationStrategy` is `lowest-price`. Value must be in the range of 1–20.
*
* Default: 2
*/
public var spotInstancePools: kotlin.Int? = null
/**
* The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.
*
* If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.
*
* Valid Range: Minimum value of 0.001
*/
public var spotMaxPrice: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.autoscaling.model.InstancesDistribution) : this() {
this.onDemandAllocationStrategy = x.onDemandAllocationStrategy
this.onDemandBaseCapacity = x.onDemandBaseCapacity
this.onDemandPercentageAboveBaseCapacity = x.onDemandPercentageAboveBaseCapacity
this.spotAllocationStrategy = x.spotAllocationStrategy
this.spotInstancePools = x.spotInstancePools
this.spotMaxPrice = x.spotMaxPrice
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.autoscaling.model.InstancesDistribution = InstancesDistribution(this)
internal fun correctErrors(): Builder {
return this
}
}
}