Package org.cdk8s.plus24

Class DeploymentStrategyRollingUpdateOptions.Builder

java.lang.Object

org.cdk8s.plus24.DeploymentStrategyRollingUpdateOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DeploymentStrategyRollingUpdateOptions>

Enclosing interface:

DeploymentStrategyRollingUpdateOptions

@Stability(Stable)
public static final class DeploymentStrategyRollingUpdateOptions.Builder
extends Object
implements software.amazon.jsii.Builder<DeploymentStrategyRollingUpdateOptions>

A builder for DeploymentStrategyRollingUpdateOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeploymentStrategyRollingUpdateOptions	build()	Builds the configured instance.
DeploymentStrategyRollingUpdateOptions.Builder	maxSurge(PercentOrAbsolute maxSurge)	Sets the value of DeploymentStrategyRollingUpdateOptions.getMaxSurge()
DeploymentStrategyRollingUpdateOptions.Builder	maxUnavailable(PercentOrAbsolute maxUnavailable)	Sets the value of DeploymentStrategyRollingUpdateOptions.getMaxUnavailable()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

maxSurge

@Stability(Stable)
public DeploymentStrategyRollingUpdateOptions.Builder maxSurge(PercentOrAbsolute maxSurge)

Sets the value of DeploymentStrategyRollingUpdateOptions.getMaxSurge()

Parameters:

maxSurge - The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if maxUnavailable is 0.

Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.

Returns:

this

maxUnavailable

@Stability(Stable)
public DeploymentStrategyRollingUpdateOptions.Builder maxUnavailable(PercentOrAbsolute maxUnavailable)

Sets the value of DeploymentStrategyRollingUpdateOptions.getMaxUnavailable()

Parameters:

maxUnavailable - The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if maxSurge is 0.

Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.

Returns:

this

build

@Stability(Stable)
public DeploymentStrategyRollingUpdateOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DeploymentStrategyRollingUpdateOptions>

Returns:

a new instance of DeploymentStrategyRollingUpdateOptions

Throws:

NullPointerException - if any required attribute was not provided