Package org.cdk8s.plus24.k8s

Class PodSpec.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<PodSpec>
    Enclosing interface:
    PodSpec
    @Stability(Stable)
public static final class PodSpec.Builder
extends Object
implements software.amazon.jsii.Builder<PodSpec>
    A builder for PodSpec

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • containers

        @Stability(Stable)
public PodSpec.Builder containers​(List<? extends Container> containers)
        Sets the value of PodSpec.getContainers()
        Parameters:
        containers - List of containers belonging to the pod. This parameter is required. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
        Returns:
        this

      • activeDeadlineSeconds

        @Stability(Stable)
public PodSpec.Builder activeDeadlineSeconds​(Number activeDeadlineSeconds)
        Sets the value of PodSpec.getActiveDeadlineSeconds()
        Parameters:
        activeDeadlineSeconds - Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
        Returns:
        this

      • automountServiceAccountToken

        @Stability(Stable)
public PodSpec.Builder automountServiceAccountToken​(Boolean automountServiceAccountToken)
        Sets the value of PodSpec.getAutomountServiceAccountToken()
        Parameters:
        automountServiceAccountToken - AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
        Returns:
        this

      • dnsConfig

        @Stability(Stable)
public PodSpec.Builder dnsConfig​(PodDnsConfig dnsConfig)
        Sets the value of PodSpec.getDnsConfig()
        Parameters:
        dnsConfig - Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
        Returns:
        this

      • dnsPolicy

        @Stability(Stable)
public PodSpec.Builder dnsPolicy​(String dnsPolicy)
        Sets the value of PodSpec.getDnsPolicy()
        Parameters:
        dnsPolicy - Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'.
        Returns:
        this

      • enableServiceLinks

        @Stability(Stable)
public PodSpec.Builder enableServiceLinks​(Boolean enableServiceLinks)
        Sets the value of PodSpec.getEnableServiceLinks()
        Parameters:
        enableServiceLinks - EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
        Returns:
        this

      • ephemeralContainers

        @Stability(Stable)
public PodSpec.Builder ephemeralContainers​(List<? extends EphemeralContainer> ephemeralContainers)
        Sets the value of PodSpec.getEphemeralContainers()
        Parameters:
        ephemeralContainers - List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is beta-level and available on clusters that haven't disabled the EphemeralContainers feature gate.
        Returns:
        this

      • hostAliases

        @Stability(Stable)
public PodSpec.Builder hostAliases​(List<? extends HostAlias> hostAliases)
        Sets the value of PodSpec.getHostAliases()
        Parameters:
        hostAliases - HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
        Returns:
        this

      • hostIpc

        @Stability(Stable)
public PodSpec.Builder hostIpc​(Boolean hostIpc)
        Sets the value of PodSpec.getHostIpc()
        Parameters:
        hostIpc - Use the host's ipc namespace. Optional: Default to false.
        Returns:
        this

      • hostname

        @Stability(Stable)
public PodSpec.Builder hostname​(String hostname)
        Sets the value of PodSpec.getHostname()
        Parameters:
        hostname - Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
        Returns:
        this

      • hostNetwork

        @Stability(Stable)
public PodSpec.Builder hostNetwork​(Boolean hostNetwork)
        Sets the value of PodSpec.getHostNetwork()
        Parameters:
        hostNetwork - Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false.
        Returns:
        this

      • hostPid

        @Stability(Stable)
public PodSpec.Builder hostPid​(Boolean hostPid)
        Sets the value of PodSpec.getHostPid()
        Parameters:
        hostPid - Use the host's pid namespace. Optional: Default to false.
        Returns:
        this

      • imagePullSecrets

        @Stability(Stable)
public PodSpec.Builder imagePullSecrets​(List<? extends LocalObjectReference> imagePullSecrets)
        Sets the value of PodSpec.getImagePullSecrets()
        Parameters:
        imagePullSecrets - ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
        Returns:
        this

      • initContainers

        @Stability(Stable)
public PodSpec.Builder initContainers​(List<? extends Container> initContainers)
        Sets the value of PodSpec.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 or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
        Returns:
        this

      • nodeName

        @Stability(Stable)
public PodSpec.Builder nodeName​(String nodeName)
        Sets the value of PodSpec.getNodeName()
        Parameters:
        nodeName - NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.
        Returns:
        this

      • nodeSelector

        @Stability(Stable)
public PodSpec.Builder nodeSelector​(Map<String,​String> nodeSelector)
        Sets the value of PodSpec.getNodeSelector()
        Parameters:
        nodeSelector - NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
        Returns:
        this

      • os

        @Stability(Stable)
public PodSpec.Builder os​(PodOs os)
        Sets the value of PodSpec.getOs()
        Parameters:
        os - Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set.

        If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions

        If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[].securityContext.seLinuxOptions - spec.containers[].securityContext.seccompProfile - spec.containers[].securityContext.capabilities - spec.containers[].securityContext.readOnlyRootFilesystem - spec.containers[].securityContext.privileged - spec.containers[].securityContext.allowPrivilegeEscalation - spec.containers[].securityContext.procMount - spec.containers[].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup This is a beta field and requires the IdentifyPodOS feature

        Returns:
        this

      • overhead

        @Stability(Stable)
public PodSpec.Builder overhead​(Map<String,​? extends Quantity> overhead)
        Sets the value of PodSpec.getOverhead()
        Parameters:
        overhead - Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md
        Returns:
        this

      • preemptionPolicy

        @Stability(Stable)
public PodSpec.Builder preemptionPolicy​(String preemptionPolicy)
        Sets the value of PodSpec.getPreemptionPolicy()
        Parameters:
        preemptionPolicy - PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
        Returns:
        this

      • priority

        @Stability(Stable)
public PodSpec.Builder priority​(Number priority)
        Sets the value of PodSpec.getPriority()
        Parameters:
        priority - The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.
        Returns:
        this

      • priorityClassName

        @Stability(Stable)
public PodSpec.Builder priorityClassName​(String priorityClassName)
        Sets the value of PodSpec.getPriorityClassName()
        Parameters:
        priorityClassName - If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.
        Returns:
        this

      • readinessGates

        @Stability(Stable)
public PodSpec.Builder readinessGates​(List<? extends PodReadinessGate> readinessGates)
        Sets the value of PodSpec.getReadinessGates()
        Parameters:
        readinessGates - If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
        Returns:
        this

      • restartPolicy

        @Stability(Stable)
public PodSpec.Builder restartPolicy​(String restartPolicy)
        Sets the value of PodSpec.getRestartPolicy()
        Parameters:
        restartPolicy - Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy
        Returns:
        this

      • runtimeClassName

        @Stability(Stable)
public PodSpec.Builder runtimeClassName​(String runtimeClassName)
        Sets the value of PodSpec.getRuntimeClassName()
        Parameters:
        runtimeClassName - RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class.
        Returns:
        this

      • schedulerName

        @Stability(Stable)
public PodSpec.Builder schedulerName​(String schedulerName)
        Sets the value of PodSpec.getSchedulerName()
        Parameters:
        schedulerName - If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
        Returns:
        this

      • securityContext

        @Stability(Stable)
public PodSpec.Builder securityContext​(PodSecurityContext securityContext)
        Sets the value of PodSpec.getSecurityContext()
        Parameters:
        securityContext - SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.
        Returns:
        this

      • serviceAccount

        @Stability(Stable)
public PodSpec.Builder serviceAccount​(String serviceAccount)
        Sets the value of PodSpec.getServiceAccount()
        Parameters:
        serviceAccount - DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
        Returns:
        this

      • serviceAccountName

        @Stability(Stable)
public PodSpec.Builder serviceAccountName​(String serviceAccountName)
        Sets the value of PodSpec.getServiceAccountName()
        Parameters:
        serviceAccountName - ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
        Returns:
        this

      • setHostnameAsFqdn

        @Stability(Stable)
public PodSpec.Builder setHostnameAsFqdn​(Boolean setHostnameAsFqdn)
        Sets the value of PodSpec.getSetHostnameAsFqdn()
        Parameters:
        setHostnameAsFqdn - If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false.
        Returns:
        this

      • shareProcessNamespace

        @Stability(Stable)
public PodSpec.Builder shareProcessNamespace​(Boolean shareProcessNamespace)
        Sets the value of PodSpec.getShareProcessNamespace()
        Parameters:
        shareProcessNamespace - Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false.
        Returns:
        this

      • subdomain

        @Stability(Stable)
public PodSpec.Builder subdomain​(String subdomain)
        Sets the value of PodSpec.getSubdomain()
        Parameters:
        subdomain - If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.
        Returns:
        this

      • terminationGracePeriodSeconds

        @Stability(Stable)
public PodSpec.Builder terminationGracePeriodSeconds​(Number terminationGracePeriodSeconds)
        Sets the value of PodSpec.getTerminationGracePeriodSeconds()
        Parameters:
        terminationGracePeriodSeconds - Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.
        Returns:
        this

      • topologySpreadConstraints

        @Stability(Stable)
public PodSpec.Builder topologySpreadConstraints​(List<? extends TopologySpreadConstraint> topologySpreadConstraints)
        Sets the value of PodSpec.getTopologySpreadConstraints()
        Parameters:
        topologySpreadConstraints - TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed.
        Returns:
        this

      • volumes

        @Stability(Stable)
public PodSpec.Builder volumes​(List<? extends Volume> volumes)
        Sets the value of PodSpec.getVolumes()
        Parameters:
        volumes - List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
        Returns:
        this

      • build

        @Stability(Stable)
public PodSpec build()
        Builds the configured instance.
        Specified by:
        build in interface software.amazon.jsii.Builder<PodSpec>
        Returns:
        a new instance of PodSpec
        Throws:
        NullPointerException - if any required attribute was not provided