Package org.cdk8s.plus24.k8s

Interface Container

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    Container.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.80.0 (build bce6a1d)",
           date="2023-05-05T16:22:33.823Z")
@Stability(Stable)
public interface Container
extends software.amazon.jsii.JsiiSerializable
    A single application container that you want to run within a pod.

    • Method Detail

      • getName

        @Stability(Stable)
@NotNull
String getName()
        Name of the container specified as a DNS_LABEL.

        Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

      • getArgs

        @Stability(Stable)
@Nullable
default List<String> getArgs()
        Arguments to the entrypoint.

        The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

      • getCommand

        @Stability(Stable)
@Nullable
default List<String> getCommand()
        Entrypoint array.

        Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

      • getEnv

        @Stability(Stable)
@Nullable
default List<EnvVar> getEnv()
        List of environment variables to set in the container.

        Cannot be updated.

      • getEnvFrom

        @Stability(Stable)
@Nullable
default List<EnvFromSource> getEnvFrom()
        List of sources to populate environment variables in the container.

        The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.

      • getImage

        @Stability(Stable)
@Nullable
default String getImage()
        Container image name.

        More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.

      • getImagePullPolicy

        @Stability(Stable)
@Nullable
default String getImagePullPolicy()
        Image pull policy.

        One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

        Default: Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

      • getLifecycle

        @Stability(Stable)
@Nullable
default Lifecycle getLifecycle()
        Actions that the management system should take in response to container lifecycle events.

        Cannot be updated.

      • getLivenessProbe

        @Stability(Stable)
@Nullable
default Probe getLivenessProbe()
        Periodic probe of container liveness.

        Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

      • getPorts

        @Stability(Stable)
@Nullable
default List<ContainerPort> getPorts()
        List of ports to expose from the container.

        Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

      • getReadinessProbe

        @Stability(Stable)
@Nullable
default Probe getReadinessProbe()
        Periodic probe of container service readiness.

        Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

      • getResources

        @Stability(Stable)
@Nullable
default ResourceRequirements getResources()
        Compute Resources required by this container.

        Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

      • getSecurityContext

        @Stability(Stable)
@Nullable
default SecurityContext getSecurityContext()
        SecurityContext defines the security options the container should be run with.

        If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

      • getStartupProbe

        @Stability(Stable)
@Nullable
default Probe getStartupProbe()
        StartupProbe indicates that the Pod has successfully initialized.

        If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

      • getStdin

        @Stability(Stable)
@Nullable
default Boolean getStdin()
        Whether this container should allocate a buffer for stdin in the container runtime.

        If this is not set, reads from stdin in the container will always result in EOF. Default is false.

        Default: false.

      • getStdinOnce

        @Stability(Stable)
@Nullable
default Boolean getStdinOnce()
        Whether the container runtime should close the stdin channel after it has been opened by a single attach.

        When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

        Default: false

      • getTerminationMessagePath

        @Stability(Stable)
@Nullable
default String getTerminationMessagePath()
        Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem.

        Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.

        Default: dev/termination-log. Cannot be updated.

      • getTerminationMessagePolicy

        @Stability(Stable)
@Nullable
default String getTerminationMessagePolicy()
        Indicate how the termination message should be populated.

        File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.

        Default: File. Cannot be updated.

      • getTty

        @Stability(Stable)
@Nullable
default Boolean getTty()
        Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.

        Default is false.

        Default: false.

      • getVolumeDevices

        @Stability(Stable)
@Nullable
default List<VolumeDevice> getVolumeDevices()
        volumeDevices is the list of block devices to be used by the container.

      • getVolumeMounts

        @Stability(Stable)
@Nullable
default List<VolumeMount> getVolumeMounts()
        Pod volumes to mount into the container's filesystem.

        Cannot be updated.

      • getWorkingDir

        @Stability(Stable)
@Nullable
default String getWorkingDir()
        Container's working directory.

        If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.