Package org.cdk8s.plus25.k8s

Interface HorizontalPodAutoscalerSpec

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HorizontalPodAutoscalerSpec.Jsii$Proxy

@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.547Z")
@Stability(Stable)
public interface HorizontalPodAutoscalerSpec
extends software.amazon.jsii.JsiiSerializable

specification of a horizontal pod autoscaler.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HorizontalPodAutoscalerSpec.Builder	A builder for HorizontalPodAutoscalerSpec
static class	HorizontalPodAutoscalerSpec.Jsii$Proxy	An implementation for HorizontalPodAutoscalerSpec

Method Summary

Modifier and Type	Method	Description
static HorizontalPodAutoscalerSpec.Builder	builder()
Number	getMaxReplicas()	upper limit for the number of pods that can be set by the autoscaler;
default Number	getMinReplicas()	minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.
CrossVersionObjectReference	getScaleTargetRef()	reference to scaled resource;
default Number	getTargetCpuUtilizationPercentage()	target average CPU utilization (represented as a percentage of requested CPU) over all the pods;

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMaxReplicas

@Stability(Stable)
@NotNull
Number getMaxReplicas()

upper limit for the number of pods that can be set by the autoscaler;

cannot be smaller than MinReplicas.

getScaleTargetRef

@Stability(Stable)
@NotNull
CrossVersionObjectReference getScaleTargetRef()

reference to scaled resource;

horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource.

getMinReplicas

@Stability(Stable)
@Nullable
default Number getMinReplicas()

minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down.

It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.

getTargetCpuUtilizationPercentage

@Stability(Stable)
@Nullable
default Number getTargetCpuUtilizationPercentage()

target average CPU utilization (represented as a percentage of requested CPU) over all the pods;

if not specified the default autoscaling policy will be used.

builder

@Stability(Stable)
static HorizontalPodAutoscalerSpec.Builder builder()

Returns:

a HorizontalPodAutoscalerSpec.Builder of HorizontalPodAutoscalerSpec