Package org.cdk8s.plus20

Interface PodSpecProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DeploymentProps, JobProps, PodProps, PodTemplateProps, StatefulSetProps

All Known Implementing Classes:

DeploymentProps.Jsii$Proxy, JobProps.Jsii$Proxy, PodProps.Jsii$Proxy, PodSpecProps.Jsii$Proxy, PodTemplateProps.Jsii$Proxy, StatefulSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.56.0 (build 55e7d15)",
           date="2022-04-13T14:52:28.924Z")
@Stability(Stable)
public interface PodSpecProps
extends software.amazon.jsii.JsiiSerializable

Properties of a `PodSpec`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PodSpecProps.Builder	builder()
default List<ContainerProps>	getContainers()	List of containers belonging to the pod.
default List<HostAlias>	getHostAliases()	HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.
default List<ContainerProps>	getInitContainers()	List of initialization containers belonging to the pod.
default RestartPolicy	getRestartPolicy()	Restart policy for all containers within the pod.
default PodSecurityContextProps	getSecurityContext()	SecurityContext holds pod-level security attributes and common container settings.
default IServiceAccount	getServiceAccount()	A service account provides an identity for processes that run in a Pod.
default List<Volume>	getVolumes()	List of volumes that can be mounted by containers belonging to the pod.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContainers

@Stability(Stable)
@Nullable
default List<ContainerProps> getContainers()

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()

Default: - No containers. Note that a pod spec must include at least one container.

getHostAliases

@Stability(Stable)
@Nullable
default List<HostAlias> getHostAliases()

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

getInitContainers

@Stability(Stable)
@Nullable
default List<ContainerProps> getInitContainers()

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

Default: - No init containers.

getRestartPolicy

@Stability(Stable)
@Nullable
default RestartPolicy getRestartPolicy()

Restart policy for all containers within the pod.

Default: RestartPolicy.ALWAYS

getSecurityContext

@Stability(Stable)
@Nullable
default PodSecurityContextProps getSecurityContext()

SecurityContext holds pod-level security attributes and common container settings.

Default: fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: false

getServiceAccount

@Stability(Stable)
@Nullable
default IServiceAccount getServiceAccount()

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

Default: - No service account.

getVolumes

@Stability(Stable)
@Nullable
default List<Volume> getVolumes()

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

Default: - No volumes.

builder

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

Returns:

a PodSpecProps.Builder of PodSpecProps