Package org.cdk8s.plus20

Class PodTemplateProps.Builder

java.lang.Object

org.cdk8s.plus20.PodTemplateProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PodTemplateProps>

Enclosing interface:

PodTemplateProps

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

A builder for PodTemplateProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PodTemplateProps	build()	Builds the configured instance.
PodTemplateProps.Builder	containers(List<? extends ContainerProps> containers)	Sets the value of PodSpecProps.getContainers()
PodTemplateProps.Builder	dns(PodDnsProps dns)	Sets the value of PodSpecProps.getDns()
PodTemplateProps.Builder	dockerRegistryAuth(DockerConfigSecret dockerRegistryAuth)	Sets the value of PodSpecProps.getDockerRegistryAuth()
PodTemplateProps.Builder	hostAliases(List<? extends HostAlias> hostAliases)	Sets the value of PodSpecProps.getHostAliases()
PodTemplateProps.Builder	initContainers(List<? extends ContainerProps> initContainers)	Sets the value of PodSpecProps.getInitContainers()
PodTemplateProps.Builder	podMetadata(org.cdk8s.ApiObjectMetadata podMetadata)	Sets the value of PodTemplateProps.getPodMetadata()
PodTemplateProps.Builder	restartPolicy(RestartPolicy restartPolicy)	Sets the value of PodSpecProps.getRestartPolicy()
PodTemplateProps.Builder	securityContext(PodSecurityContextProps securityContext)	Sets the value of PodSpecProps.getSecurityContext()
PodTemplateProps.Builder	serviceAccount(IServiceAccount serviceAccount)	Sets the value of PodSpecProps.getServiceAccount()
PodTemplateProps.Builder	volumes(List<? extends Volume> volumes)	Sets the value of PodSpecProps.getVolumes()

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

podMetadata

@Stability(Stable)
public PodTemplateProps.Builder podMetadata(org.cdk8s.ApiObjectMetadata podMetadata)

Sets the value of PodTemplateProps.getPodMetadata()

Parameters:

podMetadata - The pod metadata.

Returns:

this

containers

@Stability(Stable)
public PodTemplateProps.Builder containers(List<? extends ContainerProps> containers)

Sets the value of PodSpecProps.getContainers()

Parameters:

containers - 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()

Returns:

this

dns

@Stability(Stable)
public PodTemplateProps.Builder dns(PodDnsProps dns)

Sets the value of PodSpecProps.getDns()

Parameters:

dns - DNS settings for the pod.

Returns:

this

dockerRegistryAuth

@Stability(Stable)
public PodTemplateProps.Builder dockerRegistryAuth(DockerConfigSecret dockerRegistryAuth)

Sets the value of PodSpecProps.getDockerRegistryAuth()

Parameters:

dockerRegistryAuth - A secret containing docker credentials for authenticating to a registry.

Returns:

this

hostAliases

@Stability(Stable)
public PodTemplateProps.Builder hostAliases(List<? extends HostAlias> hostAliases)

Sets the value of PodSpecProps.getHostAliases()

Parameters:

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

Returns:

this

initContainers

@Stability(Stable)
public PodTemplateProps.Builder initContainers(List<? extends ContainerProps> initContainers)

Sets the value of PodSpecProps.getInitContainers()

Parameters:

initContainers - 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.

Returns:

this

restartPolicy

@Stability(Stable)
public PodTemplateProps.Builder restartPolicy(RestartPolicy restartPolicy)

Sets the value of PodSpecProps.getRestartPolicy()

Parameters:

restartPolicy - Restart policy for all containers within the pod.

Returns:

this

securityContext

@Stability(Stable)
public PodTemplateProps.Builder securityContext(PodSecurityContextProps securityContext)

Sets the value of PodSpecProps.getSecurityContext()

Parameters:

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

Returns:

this

serviceAccount

@Stability(Stable)
public PodTemplateProps.Builder serviceAccount(IServiceAccount serviceAccount)

Sets the value of PodSpecProps.getServiceAccount()

Parameters:

serviceAccount - 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).

Returns:

this

volumes

@Stability(Stable)
public PodTemplateProps.Builder volumes(List<? extends Volume> volumes)

Sets the value of PodSpecProps.getVolumes()

Parameters:

volumes - List of volumes that can be mounted by containers belonging to the pod. You can also add volumes later using podSpec.addVolume()

Returns:

this

build

@Stability(Stable)
public PodTemplateProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PodTemplateProps

Throws:

NullPointerException - if any required attribute was not provided