Package org.cdk8s.plus25

Interface ContainerLifecycle

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ContainerLifecycle.Jsii$Proxy

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

Container lifecycle properties.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContainerLifecycle.Builder	builder()
default Handler	getPostStart()	This hook is executed immediately after a container is created.
default Handler	getPreStop()	This hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPostStart

@Stability(Stable)
@Nullable
default Handler getPostStart()

This hook is executed immediately after a container is created.

However, there is no guarantee that the hook will execute before the container ENTRYPOINT.

Default: - No post start handler.

getPreStop

@Stability(Stable)
@Nullable
default Handler getPreStop()

This hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others.

A call to the PreStop hook fails if the container is already in a terminated or completed state and the hook must complete before the TERM signal to stop the container can be sent. The Pod's termination grace period countdown begins before the PreStop hook is executed, so regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period. No parameters are passed to the handler.

Default: - No pre stop handler.

See Also:

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination

builder

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

Returns:

a ContainerLifecycle.Builder of ContainerLifecycle