Package org.cdk8s.plus25

Interface HorizontalPodAutoscalerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceProps

All Known Implementing Classes:

HorizontalPodAutoscalerProps.Jsii$Proxy

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

Properties for HorizontalPodAutoscaler.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HorizontalPodAutoscalerProps.Builder	builder()
Number	getMaxReplicas()	The maximum number of replicas that can be scaled up to.
default List<Metric>	getMetrics()	The metric conditions that trigger a scale up or scale down.
default Number	getMinReplicas()	The minimum number of replicas that can be scaled down to.
default ScalingRules	getScaleDown()	The scaling behavior when scaling down.
default ScalingRules	getScaleUp()	The scaling behavior when scaling up.
IScalable	getTarget()	The workload to scale up or down.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface org.cdk8s.plus25.ResourceProps

getMetadata

Method Detail

getMaxReplicas

@Stability(Stable)
@NotNull
Number getMaxReplicas()

The maximum number of replicas that can be scaled up to.

getTarget

@Stability(Stable)
@NotNull
IScalable getTarget()

The workload to scale up or down.

Scalable workload types:

• Deployment
• StatefulSet

getMetrics

@Stability(Stable)
@Nullable
default List<Metric> getMetrics()

The metric conditions that trigger a scale up or scale down.

Default: - If metrics are not provided, then the target resource constraints (e.g. cpu limit) will be used as scaling metrics.

getMinReplicas

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

The minimum number of replicas that can be scaled down to.

Can be set to 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured.

Default: 1

getScaleDown

@Stability(Stable)
@Nullable
default ScalingRules getScaleDown()

The scaling behavior when scaling down.

Default: - Scale down to minReplica count with a 5 minute stabilization window.

getScaleUp

@Stability(Stable)
@Nullable
default ScalingRules getScaleUp()

The scaling behavior when scaling up.

Default: - Is the higher of: * Increase no more than 4 pods per 60 seconds * Double the number of pods per 60 seconds

builder

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

Returns:

a HorizontalPodAutoscalerProps.Builder of HorizontalPodAutoscalerProps