Package org.cdk8s.plus20

Class DeploymentProps.Builder

java.lang.Object

org.cdk8s.plus20.DeploymentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DeploymentProps>

Enclosing interface:

DeploymentProps

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

A builder for DeploymentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeploymentProps	build()	Builds the configured instance.
DeploymentProps.Builder	containers(List<? extends ContainerProps> containers)	Sets the value of PodSpecProps.getContainers()
DeploymentProps.Builder	defaultSelector(Boolean defaultSelector)	Sets the value of DeploymentProps.getDefaultSelector()
DeploymentProps.Builder	metadata(org.cdk8s.ApiObjectMetadata metadata)	Sets the value of ResourceProps.getMetadata()
DeploymentProps.Builder	podMetadata(org.cdk8s.ApiObjectMetadata podMetadata)	Sets the value of PodTemplateProps.getPodMetadata()
DeploymentProps.Builder	replicas(Number replicas)	Sets the value of DeploymentProps.getReplicas()
DeploymentProps.Builder	restartPolicy(RestartPolicy restartPolicy)	Sets the value of PodSpecProps.getRestartPolicy()
DeploymentProps.Builder	serviceAccount(IServiceAccount serviceAccount)	Sets the value of PodSpecProps.getServiceAccount()
DeploymentProps.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

defaultSelector

@Stability(Stable)
public DeploymentProps.Builder defaultSelector(Boolean defaultSelector)

Sets the value of DeploymentProps.getDefaultSelector()

Parameters:

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

Returns:

this

replicas

@Stability(Stable)
public DeploymentProps.Builder replicas(Number replicas)

Sets the value of DeploymentProps.getReplicas()

Parameters:

replicas - Number of desired pods.

Returns:

this

metadata

@Stability(Stable)
public DeploymentProps.Builder metadata(org.cdk8s.ApiObjectMetadata metadata)

Sets the value of ResourceProps.getMetadata()

Parameters:

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

Returns:

this

podMetadata

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

Sets the value of PodTemplateProps.getPodMetadata()

Parameters:

podMetadata - The pod metadata.

Returns:

this

containers

@Stability(Stable)
public DeploymentProps.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

restartPolicy

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

Sets the value of PodSpecProps.getRestartPolicy()

Parameters:

restartPolicy - Restart policy for all containers within the pod.

Returns:

this

serviceAccount

@Stability(Stable)
public DeploymentProps.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 DeploymentProps.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 DeploymentProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DeploymentProps

Throws:

NullPointerException - if any required attribute was not provided