com.pulumi.awsnative.autoscaling.kotlin.inputs.ScalingPolicyPredictiveScalingConfigurationArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.autoscaling.kotlin.inputs
import com.pulumi.awsnative.autoscaling.inputs.ScalingPolicyPredictiveScalingConfigurationArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiNullFieldException
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
*
* @property maxCapacityBreachBehavior Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to `HonorMaxCapacity` if not specified.
* The following are possible values:
* - `HonorMaxCapacity` - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.
* - `IncreaseMaxCapacity` - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for `MaxCapacityBuffer` .
* > Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
* @property maxCapacityBuffer The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
* If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.
* Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise.
* @property metricSpecifications This structure includes the metrics and target utilization to use for predictive scaling.
* This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
* @property mode The predictive scaling mode. Defaults to `ForecastOnly` if not specified.
* @property schedulingBufferTime The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
*/
public data class ScalingPolicyPredictiveScalingConfigurationArgs(
public val maxCapacityBreachBehavior: Output? = null,
public val maxCapacityBuffer: Output? = null,
public val metricSpecifications: Output>,
public val mode: Output? = null,
public val schedulingBufferTime: Output? = null,
) :
ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.autoscaling.inputs.ScalingPolicyPredictiveScalingConfigurationArgs =
com.pulumi.awsnative.autoscaling.inputs.ScalingPolicyPredictiveScalingConfigurationArgs.builder()
.maxCapacityBreachBehavior(maxCapacityBreachBehavior?.applyValue({ args0 -> args0 }))
.maxCapacityBuffer(maxCapacityBuffer?.applyValue({ args0 -> args0 }))
.metricSpecifications(
metricSpecifications.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> args0.toJava() })
})
}),
)
.mode(mode?.applyValue({ args0 -> args0 }))
.schedulingBufferTime(schedulingBufferTime?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ScalingPolicyPredictiveScalingConfigurationArgs].
*/
@PulumiTagMarker
public class ScalingPolicyPredictiveScalingConfigurationArgsBuilder internal constructor() {
private var maxCapacityBreachBehavior: Output? = null
private var maxCapacityBuffer: Output? = null
private var metricSpecifications:
Output>? = null
private var mode: Output? = null
private var schedulingBufferTime: Output? = null
/**
* @param value Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to `HonorMaxCapacity` if not specified.
* The following are possible values:
* - `HonorMaxCapacity` - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.
* - `IncreaseMaxCapacity` - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for `MaxCapacityBuffer` .
* > Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
*/
@JvmName("gqqitllblppogiou")
public suspend fun maxCapacityBreachBehavior(`value`: Output) {
this.maxCapacityBreachBehavior = value
}
/**
* @param value The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
* If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.
* Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise.
*/
@JvmName("dfocunhuctwivmgn")
public suspend fun maxCapacityBuffer(`value`: Output) {
this.maxCapacityBuffer = value
}
/**
* @param value This structure includes the metrics and target utilization to use for predictive scaling.
* This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
*/
@JvmName("jcpnndjahifueoca")
public suspend fun metricSpecifications(`value`: Output>) {
this.metricSpecifications = value
}
@JvmName("watefbmjrdatoqft")
public suspend fun metricSpecifications(vararg values: Output) {
this.metricSpecifications = Output.all(values.asList())
}
/**
* @param values This structure includes the metrics and target utilization to use for predictive scaling.
* This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
*/
@JvmName("hhxptrxlajviecpm")
public suspend fun metricSpecifications(values: List>) {
this.metricSpecifications = Output.all(values)
}
/**
* @param value The predictive scaling mode. Defaults to `ForecastOnly` if not specified.
*/
@JvmName("nsewcwsstvlearnm")
public suspend fun mode(`value`: Output) {
this.mode = value
}
/**
* @param value The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
*/
@JvmName("uwdtpkvefrdgpajl")
public suspend fun schedulingBufferTime(`value`: Output) {
this.schedulingBufferTime = value
}
/**
* @param value Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity of the Auto Scaling group. Defaults to `HonorMaxCapacity` if not specified.
* The following are possible values:
* - `HonorMaxCapacity` - Amazon EC2 Auto Scaling can't increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity.
* - `IncreaseMaxCapacity` - Amazon EC2 Auto Scaling can increase the maximum capacity of the group when the forecast capacity is close to or exceeds the maximum capacity. The upper limit is determined by the forecasted capacity and the value for `MaxCapacityBuffer` .
* > Use caution when allowing the maximum capacity to be automatically increased. This can lead to more instances being launched than intended if the increased maximum capacity is not monitored and managed. The increased maximum capacity then becomes the new normal maximum capacity for the Auto Scaling group until you manually update it. The maximum capacity does not automatically decrease back to the original maximum.
*/
@JvmName("ukladkkovtqkvcmk")
public suspend fun maxCapacityBreachBehavior(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.maxCapacityBreachBehavior = mapped
}
/**
* @param value The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
* If set to 0, Amazon EC2 Auto Scaling may scale capacity higher than the maximum capacity to equal but not exceed forecast capacity.
* Required if the `MaxCapacityBreachBehavior` property is set to `IncreaseMaxCapacity` , and cannot be used otherwise.
*/
@JvmName("tpsbdyydydokbarp")
public suspend fun maxCapacityBuffer(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.maxCapacityBuffer = mapped
}
/**
* @param value This structure includes the metrics and target utilization to use for predictive scaling.
* This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
*/
@JvmName("dfygdilfdcffjmxs")
public suspend fun metricSpecifications(`value`: List) {
val toBeMapped = value
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.metricSpecifications = mapped
}
/**
* @param argument This structure includes the metrics and target utilization to use for predictive scaling.
* This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
*/
@JvmName("kwhrqxsstglechli")
public suspend fun metricSpecifications(argument: List Unit>) {
val toBeMapped = argument.toList().map {
ScalingPolicyPredictiveScalingMetricSpecificationArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.metricSpecifications = mapped
}
/**
* @param argument This structure includes the metrics and target utilization to use for predictive scaling.
* This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
*/
@JvmName("ysutdmmvyqurfkhs")
public suspend fun metricSpecifications(vararg argument: suspend ScalingPolicyPredictiveScalingMetricSpecificationArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
ScalingPolicyPredictiveScalingMetricSpecificationArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.metricSpecifications = mapped
}
/**
* @param argument This structure includes the metrics and target utilization to use for predictive scaling.
* This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
*/
@JvmName("gxplaaossjtfstci")
public suspend fun metricSpecifications(argument: suspend ScalingPolicyPredictiveScalingMetricSpecificationArgsBuilder.() -> Unit) {
val toBeMapped =
listOf(
ScalingPolicyPredictiveScalingMetricSpecificationArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.metricSpecifications = mapped
}
/**
* @param values This structure includes the metrics and target utilization to use for predictive scaling.
* This is an array, but we currently only support a single metric specification. That is, you can specify a target value and a single metric pair, or a target value and one scaling metric and one load metric.
*/
@JvmName("hypnfrpatggjlqho")
public suspend fun metricSpecifications(vararg values: ScalingPolicyPredictiveScalingMetricSpecificationArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.metricSpecifications = mapped
}
/**
* @param value The predictive scaling mode. Defaults to `ForecastOnly` if not specified.
*/
@JvmName("cdpyxcbysiagekyx")
public suspend fun mode(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.mode = mapped
}
/**
* @param value The amount of time, in seconds, by which the instance launch time can be advanced. For example, the forecast says to add capacity at 10:00 AM, and you choose to pre-launch instances by 5 minutes. In that case, the instances will be launched at 9:55 AM. The intention is to give resources time to be provisioned. It can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
* The value must be less than the forecast interval duration of 3600 seconds (60 minutes). Defaults to 300 seconds if not specified.
*/
@JvmName("fcvqycfwmfmqloyi")
public suspend fun schedulingBufferTime(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.schedulingBufferTime = mapped
}
internal fun build(): ScalingPolicyPredictiveScalingConfigurationArgs =
ScalingPolicyPredictiveScalingConfigurationArgs(
maxCapacityBreachBehavior = maxCapacityBreachBehavior,
maxCapacityBuffer = maxCapacityBuffer,
metricSpecifications = metricSpecifications ?: throw
PulumiNullFieldException("metricSpecifications"),
mode = mode,
schedulingBufferTime = schedulingBufferTime,
)
}