Package org.cdk8s.plus25.k8s

Class PodSpec.Jsii$Proxy

  • All Implemented Interfaces:
    PodSpec, software.amazon.jsii.JsiiSerializable
    Enclosing interface:
    PodSpec
    @Stability(Stable)
@Internal
public static final class PodSpec.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements PodSpec
    An implementation for PodSpec

    • Constructor Detail

      • Jsii$Proxy

        protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
        Constructor that initializes the object based on values retrieved from the JsiiObject.
        Parameters:
        objRef - Reference to the JSII managed object.

      • Jsii$Proxy

        protected Jsii$Proxy​(PodSpec.Builder builder)
        Constructor that initializes the object based on literal property values passed by the PodSpec.Builder.

    • Method Detail

      • getContainers

        public final List<Container> getContainers()
        Description copied from interface: PodSpec
        List of containers belonging to the pod.

        Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.

        Specified by:
        getContainers in interface PodSpec

      • getActiveDeadlineSeconds

        public final Number getActiveDeadlineSeconds()
        Description copied from interface: PodSpec
        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.

        Specified by:
        getActiveDeadlineSeconds in interface PodSpec

      • getAffinity

        public final Affinity getAffinity()
        Description copied from interface: PodSpec
        If specified, the pod's scheduling constraints.
        Specified by:
        getAffinity in interface PodSpec

      • getAutomountServiceAccountToken

        public final Boolean getAutomountServiceAccountToken()
        Description copied from interface: PodSpec
        AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
        Specified by:
        getAutomountServiceAccountToken in interface PodSpec

      • getDnsConfig

        public final PodDnsConfig getDnsConfig()
        Description copied from interface: PodSpec
        Specifies the DNS parameters of a pod.

        Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.

        Specified by:
        getDnsConfig in interface PodSpec

      • getDnsPolicy

        public final String getDnsPolicy()
        Description copied from interface: PodSpec
        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'.

        Default: 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'.

        Specified by:
        getDnsPolicy in interface PodSpec

      • getEnableServiceLinks

        public final Boolean getEnableServiceLinks()
        Description copied from interface: PodSpec
        EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links.

        Optional: Defaults to true.

        Default: true.

        Specified by:
        getEnableServiceLinks in interface PodSpec

      • getEphemeralContainers

        public final List<EphemeralContainer> getEphemeralContainers()
        Description copied from interface: PodSpec
        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.

        Specified by:
        getEphemeralContainers in interface PodSpec

      • getHostAliases

        public final List<HostAlias> getHostAliases()
        Description copied from interface: PodSpec
        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.

        Specified by:
        getHostAliases in interface PodSpec

      • getHostIpc

        public final Boolean getHostIpc()
        Description copied from interface: PodSpec
        Use the host's ipc namespace.

        Optional: Default to false.

        Default: false.

        Specified by:
        getHostIpc in interface PodSpec

      • getHostname

        public final String getHostname()
        Description copied from interface: PodSpec
        Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
        Specified by:
        getHostname in interface PodSpec

      • getHostNetwork

        public final Boolean getHostNetwork()
        Description copied from interface: PodSpec
        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.

        Default: false.

        Specified by:
        getHostNetwork in interface PodSpec

      • getHostPid

        public final Boolean getHostPid()
        Description copied from interface: PodSpec
        Use the host's pid namespace.

        Optional: Default to false.

        Default: false.

        Specified by:
        getHostPid in interface PodSpec

      • getHostUsers

        public final Boolean getHostUsers()
        Description copied from interface: PodSpec
        Use the host's user namespace.

        Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.

        Default: true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature.

        Specified by:
        getHostUsers in interface PodSpec

      • getImagePullSecrets

        public final List<LocalObjectReference> getImagePullSecrets()
        Description copied from interface: PodSpec
        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

        Specified by:
        getImagePullSecrets in interface PodSpec

      • getInitContainers

        public final List<Container> getInitContainers()
        Description copied from interface: PodSpec
        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/

        Specified by:
        getInitContainers in interface PodSpec

      • getNodeName

        public final String getNodeName()
        Description copied from interface: PodSpec
        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.

        Specified by:
        getNodeName in interface PodSpec

      • getNodeSelector

        public final Map<String,​String> getNodeSelector()
        Description copied from interface: PodSpec
        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/

        Specified by:
        getNodeSelector in interface PodSpec

      • getOs

        public final PodOs getOs()
        Description copied from interface: PodSpec
        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.hostUsers - 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

        Specified by:
        getOs in interface PodSpec

      • getOverhead

        public final Map<String,​Quantity> getOverhead()
        Description copied from interface: PodSpec
        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

        Specified by:
        getOverhead in interface PodSpec

      • getPreemptionPolicy

        public final String getPreemptionPolicy()
        Description copied from interface: PodSpec
        PreemptionPolicy is the Policy for preempting pods with lower priority.

        One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.

        Default: PreemptLowerPriority if unset.

        Specified by:
        getPreemptionPolicy in interface PodSpec

      • getPriority

        public final Number getPriority()
        Description copied from interface: PodSpec
        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.

        Specified by:
        getPriority in interface PodSpec

      • getPriorityClassName

        public final String getPriorityClassName()
        Description copied from interface: PodSpec
        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.

        Specified by:
        getPriorityClassName in interface PodSpec

      • getReadinessGates

        public final List<PodReadinessGate> getReadinessGates()
        Description copied from interface: PodSpec
        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

        Specified by:
        getReadinessGates in interface PodSpec

      • getRestartPolicy

        public final String getRestartPolicy()
        Description copied from interface: PodSpec
        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

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

        Specified by:
        getRestartPolicy in interface PodSpec

      • getRuntimeClassName

        public final String getRuntimeClassName()
        Description copied from interface: PodSpec
        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.
        Specified by:
        getRuntimeClassName in interface PodSpec

      • getSchedulerName

        public final String getSchedulerName()
        Description copied from interface: PodSpec
        If specified, the pod will be dispatched by specified scheduler.

        If not specified, the pod will be dispatched by default scheduler.

        Specified by:
        getSchedulerName in interface PodSpec

      • getSecurityContext

        public final PodSecurityContext getSecurityContext()
        Description copied from interface: PodSpec
        SecurityContext holds pod-level security attributes and common container settings.

        Optional: Defaults to empty. See type description for default values of each field.

        Default: empty. See type description for default values of each field.

        Specified by:
        getSecurityContext in interface PodSpec

      • getServiceAccount

        public final String getServiceAccount()
        Description copied from interface: PodSpec
        DeprecatedServiceAccount is a depreciated alias for ServiceAccountName.

        Deprecated: Use serviceAccountName instead.

        Specified by:
        getServiceAccount in interface PodSpec

      • getServiceAccountName

        public final String getServiceAccountName()
        Description copied from interface: PodSpec
        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/

        Specified by:
        getServiceAccountName in interface PodSpec

      • getSetHostnameAsFqdn

        public final Boolean getSetHostnameAsFqdn()
        Description copied from interface: PodSpec
        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.

        Default: false.

        Specified by:
        getSetHostnameAsFqdn in interface PodSpec

      • getShareProcessNamespace

        public final Boolean getShareProcessNamespace()
        Description copied from interface: PodSpec
        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.

        Default: false.

        Specified by:
        getShareProcessNamespace in interface PodSpec

      • getSubdomain

        public final String getSubdomain()
        Description copied from interface: PodSpec
        If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.
        Specified by:
        getSubdomain in interface PodSpec

      • getTerminationGracePeriodSeconds

        public final Number getTerminationGracePeriodSeconds()
        Description copied from interface: PodSpec
        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.

        Default: 30 seconds.

        Specified by:
        getTerminationGracePeriodSeconds in interface PodSpec

      • getTopologySpreadConstraints

        public final List<TopologySpreadConstraint> getTopologySpreadConstraints()
        Description copied from interface: PodSpec
        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.

        Specified by:
        getTopologySpreadConstraints in interface PodSpec

      • getVolumes

        public final List<Volume> getVolumes()
        Description copied from interface: PodSpec
        List of volumes that can be mounted by containers belonging to the pod.

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

        Specified by:
        getVolumes in interface PodSpec

      • $jsii$toJson

        @Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object