Package org.cdk8s.plus24

Interface StatefulSetProps

All Superinterfaces:

AbstractPodProps, software.amazon.jsii.JsiiSerializable, ResourceProps, WorkloadProps

All Known Implementing Classes:

StatefulSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.75.0 (build 63bb957)",
           date="2023-02-21T02:37:35.324Z")
@Stability(Stable)
public interface StatefulSetProps
extends software.amazon.jsii.JsiiSerializable, WorkloadProps

Properties for initialization of `StatefulSet`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StatefulSetProps.Builder	builder()
default org.cdk8s.Duration	getMinReady()	Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.
default PodManagementPolicy	getPodManagementPolicy()	Pod management policy to use for this statefulset.
default Number	getReplicas()	Number of desired pods.
default Service	getService()	Service to associate with the statefulset.
default StatefulSetUpdateStrategy	getStrategy()	Indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

Methods inherited from interface org.cdk8s.plus24.AbstractPodProps

getAutomountServiceAccountToken, getContainers, getDns, getDockerRegistryAuth, getHostAliases, getInitContainers, getIsolate, getRestartPolicy, getSecurityContext, getServiceAccount, getVolumes

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface org.cdk8s.plus24.ResourceProps

getMetadata

Methods inherited from interface org.cdk8s.plus24.WorkloadProps

getPodMetadata, getSelect, getSpread

Method Detail

getMinReady

@Stability(Stable)
@Nullable
default org.cdk8s.Duration getMinReady()

Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.

Zero means the pod will be considered available as soon as it is ready.

This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.

Default: Duration.seconds(0)

See Also:

https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds

getPodManagementPolicy

@Stability(Stable)
@Nullable
default PodManagementPolicy getPodManagementPolicy()

Pod management policy to use for this statefulset.

Default: PodManagementPolicy.ORDERED_READY

getReplicas

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

Number of desired pods.

Default: 1

getService

@Stability(Stable)
@Nullable
default Service getService()

Service to associate with the statefulset.

Default: - A new headless service will be created.

getStrategy

@Stability(Stable)
@Nullable
default StatefulSetUpdateStrategy getStrategy()

Indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.

Default: - RollingUpdate with partition set to 0

builder

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

Returns:

a StatefulSetProps.Builder of StatefulSetProps