org.cdk8s.plus20

Class Deployment.Builder

java.lang.Object

org.cdk8s.plus20.Deployment.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Deployment>

Enclosing class:

Deployment

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

A fluent builder for Deployment.

Method Summary

Modifier and Type	Method and Description
Deployment	build()
Deployment.Builder	containers(List<? extends ContainerProps> containers) List of containers belonging to the pod.
static Deployment.Builder	create(software.constructs.Construct scope, String id)
Deployment.Builder	defaultSelector(Boolean defaultSelector) Automatically allocates a pod selector for this deployment.
Deployment.Builder	metadata(org.cdk8s.ApiObjectMetadata metadata) Metadata that all persisted resources must have, which includes all objects users must create.
Deployment.Builder	podMetadata(org.cdk8s.ApiObjectMetadata podMetadata) The pod metadata.
Deployment.Builder	replicas(Number replicas) Number of desired pods.
Deployment.Builder	restartPolicy(RestartPolicy restartPolicy) Restart policy for all containers within the pod.
Deployment.Builder	serviceAccount(IServiceAccount serviceAccount) A service account provides an identity for processes that run in a Pod.
Deployment.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 Deployment.Builder create(software.constructs.Construct scope,
                                                                 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Deployment.Builder.

metadata

@Stability(value=Stable)
public Deployment.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 Deployment.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 Deployment.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 Deployment.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 Deployment.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

podMetadata

@Stability(value=Stable)
public Deployment.Builder podMetadata(org.cdk8s.ApiObjectMetadata podMetadata)

The pod metadata.

Parameters:

podMetadata - The pod metadata. This parameter is required.

Returns:

this

defaultSelector

@Stability(value=Stable)
public Deployment.Builder defaultSelector(Boolean defaultSelector)

Automatically allocates a pod selector for this deployment.

If this is set to false you must define your selector through deployment.podMetadata.addLabel() and deployment.selectByLabel().

Default: true

Parameters:

defaultSelector - Automatically allocates a pod selector for this deployment. This parameter is required.

Returns:

this

replicas

@Stability(value=Stable)
public Deployment.Builder replicas(Number replicas)

Number of desired pods.

Default: 1

Parameters:

replicas - Number of desired pods. This parameter is required.

Returns:

this

build

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

Specified by:

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