All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EphemeralContainer.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.79.0 (build b22f628)",
           date="2023-03-31T02:28:41.784Z")
@Stability(Stable)
public interface EphemeralContainer
extends software.amazon.jsii.JsiiSerializable
```
An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging.
Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation.
To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.
This is a beta feature available on clusters that haven't disabled the EphemeralContainers feature gate.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`EphemeralContainer.Builder`	A builder for `EphemeralContainer`
`static class`	`EphemeralContainer.Jsii$Proxy`	An implementation for `EphemeralContainer`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`static EphemeralContainer.Builder`	`builder()`
`default List<String>`	`getArgs()`	Arguments to the entrypoint.
`default List<String>`	`getCommand()`	Entrypoint array.
`default List<EnvVar>`	`getEnv()`	List of environment variables to set in the container.
`default List<EnvFromSource>`	`getEnvFrom()`	List of sources to populate environment variables in the container.
`default String`	`getImage()`	Container image name.
`default String`	`getImagePullPolicy()`	Image pull policy.
`default Lifecycle`	`getLifecycle()`	Lifecycle is not allowed for ephemeral containers.
`default Probe`	`getLivenessProbe()`	Probes are not allowed for ephemeral containers.
`String`	`getName()`	Name of the ephemeral container specified as a DNS_LABEL.
`default List<ContainerPort>`	`getPorts()`	Ports are not allowed for ephemeral containers.
`default Probe`	`getReadinessProbe()`	Probes are not allowed for ephemeral containers.
`default ResourceRequirements`	`getResources()`	Resources are not allowed for ephemeral containers.
`default SecurityContext`	`getSecurityContext()`	Optional: SecurityContext defines the security options the ephemeral container should be run with.
`default Probe`	`getStartupProbe()`	Probes are not allowed for ephemeral containers.
`default Boolean`	`getStdin()`	Whether this container should allocate a buffer for stdin in the container runtime.
`default Boolean`	`getStdinOnce()`	Whether the container runtime should close the stdin channel after it has been opened by a single attach.
`default String`	`getTargetContainerName()`	If set, the name of the container from PodSpec that this ephemeral container targets.
`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.
`default String`	`getTerminationMessagePolicy()`	Indicate how the termination message should be populated.
`default Boolean`	`getTty()`	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
`default List<VolumeDevice>`	`getVolumeDevices()`	volumeDevices is the list of block devices to be used by the container.
`default List<VolumeMount>`	`getVolumeMounts()`	Pod volumes to mount into the container's filesystem.
`default String`	`getWorkingDir()`	Container's working directory.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getName
```
@Stability(Stable)
@NotNull
String getName()
```
    Name of the ephemeral container specified as a DNS_LABEL.
    This name must be unique among all containers, init containers and ephemeral containers.
  - getArgs
```
@Stability(Stable)
@Nullable
default List<String> getArgs()
```
    Arguments to the entrypoint.
    The 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 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
  - 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()
```
    Lifecycle is not allowed for ephemeral containers.
  - getLivenessProbe
```
@Stability(Stable)
@Nullable
default Probe getLivenessProbe()
```
    Probes are not allowed for ephemeral containers.
  - getPorts
```
@Stability(Stable)
@Nullable
default List<ContainerPort> getPorts()
```
    Ports are not allowed for ephemeral containers.
  - getReadinessProbe
```
@Stability(Stable)
@Nullable
default Probe getReadinessProbe()
```
    Probes are not allowed for ephemeral containers.
  - getResources
```
@Stability(Stable)
@Nullable
default ResourceRequirements getResources()
```
    Resources are not allowed for ephemeral containers.
    Ephemeral containers use spare resources already allocated to the pod.
  - getSecurityContext
```
@Stability(Stable)
@Nullable
default SecurityContext getSecurityContext()
```
    Optional: SecurityContext defines the security options the ephemeral container should be run with.
    If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
  - getStartupProbe
```
@Stability(Stable)
@Nullable
default Probe getStartupProbe()
```
    Probes are not allowed for ephemeral containers.
  - 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
  - getTargetContainerName
```
@Stability(Stable)
@Nullable
default String getTargetContainerName()
```
    If set, the name of the container from PodSpec that this ephemeral container targets.
    The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec.
    The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined.
  - 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.
    Subpath mounts are not allowed for ephemeral containers. 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.
  - builder
```
@Stability(Stable)
static EphemeralContainer.Builder builder()
```
    Returns:
    
    a EphemeralContainer.Builder of EphemeralContainer

Interface EphemeralContainer

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getName

getArgs

getCommand

getEnv

getEnvFrom

getImage

getImagePullPolicy

getLifecycle

getLivenessProbe

getPorts

getReadinessProbe

getResources

getSecurityContext

getStartupProbe

getStdin

getStdinOnce

getTargetContainerName

getTerminationMessagePath

getTerminationMessagePolicy

getTty

getVolumeDevices

getVolumeMounts

getWorkingDir

builder