org.cdk8s.plus20

Class Pod.Builder

java.lang.Object

org.cdk8s.plus20.Pod.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Pod>

Enclosing class:

Pod

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

A fluent builder for Pod.

Method Summary

Modifier and Type	Method and Description
Pod	build()
Pod.Builder	containers(List<? extends ContainerProps> containers) List of containers belonging to the pod.
static Pod.Builder	create(software.constructs.Construct scope, String id)
Pod.Builder	metadata(org.cdk8s.ApiObjectMetadata metadata) Metadata that all persisted resources must have, which includes all objects users must create.
Pod.Builder	restartPolicy(RestartPolicy restartPolicy) Restart policy for all containers within the pod.
Pod.Builder	serviceAccount(IServiceAccount serviceAccount) A service account provides an identity for processes that run in a Pod.
Pod.Builder	volumes(List<? extends Volume> volumes) List of volumes that can be mounted by containers belonging to the pod.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static Pod.Builder create(software.constructs.Construct scope,
                                                          String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Pod.Builder.

metadata

@Stability(value=Stable)
public Pod.Builder metadata(org.cdk8s.ApiObjectMetadata metadata)

Metadata that all persisted resources must have, which includes all objects users must create.

Parameters:

metadata - Metadata that all persisted resources must have, which includes all objects users must create. This parameter is required.

Returns:

this

containers

@Stability(value=Stable)
public Pod.Builder containers(List<? extends ContainerProps> 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()

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

Parameters:

containers - List of containers belonging to the pod. This parameter is required.

Returns:

this

restartPolicy

@Stability(value=Stable)
public Pod.Builder restartPolicy(RestartPolicy restartPolicy)

Restart policy for all containers within the pod.

Default: RestartPolicy.ALWAYS

Parameters:

restartPolicy - Restart policy for all containers within the pod. This parameter is required.

Returns:

this

See Also:

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

serviceAccount

@Stability(value=Stable)
public Pod.Builder serviceAccount(IServiceAccount 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).

Default: - No service account.

Parameters:

serviceAccount - A service account provides an identity for processes that run in a Pod. This parameter is required.

Returns:

this

See Also:

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

volumes

@Stability(value=Stable)
public Pod.Builder volumes(List<? extends Volume> volumes)

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.

Parameters:

volumes - List of volumes that can be mounted by containers belonging to the pod. This parameter is required.

Returns:

this

See Also:

https://kubernetes.io/docs/concepts/storage/volumes

build

@Stability(value=Stable)
public Pod build()

Specified by:

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