Class EphemeralContainer.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- org.cdk8s.plus24.k8s.EphemeralContainer.Jsii$Proxy
-
- All Implemented Interfaces:
EphemeralContainer
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- EphemeralContainer
@Stability(Stable) @Internal public static final class EphemeralContainer.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements EphemeralContainer
An implementation forEphemeralContainer
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Nested classes/interfaces inherited from interface org.cdk8s.plus24.k8s.EphemeralContainer
EphemeralContainer.Builder, EphemeralContainer.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
Jsii$Proxy(EphemeralContainer.Builder builder)
Constructor that initializes the object based on literal property values passed by theEphemeralContainer.Builder
.protected
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode
$jsii$toJson()
boolean
equals(Object o)
List<String>
getArgs()
Arguments to the entrypoint.List<String>
getCommand()
Entrypoint array.List<EnvVar>
getEnv()
List of environment variables to set in the container.List<EnvFromSource>
getEnvFrom()
List of sources to populate environment variables in the container.String
getImage()
Container image name.String
getImagePullPolicy()
Image pull policy.Lifecycle
getLifecycle()
Lifecycle is not allowed for ephemeral containers.Probe
getLivenessProbe()
Probes are not allowed for ephemeral containers.String
getName()
Name of the ephemeral container specified as a DNS_LABEL.List<ContainerPort>
getPorts()
Ports are not allowed for ephemeral containers.Probe
getReadinessProbe()
Probes are not allowed for ephemeral containers.ResourceRequirements
getResources()
Resources are not allowed for ephemeral containers.SecurityContext
getSecurityContext()
Optional: SecurityContext defines the security options the ephemeral container should be run with.Probe
getStartupProbe()
Probes are not allowed for ephemeral containers.Boolean
getStdin()
Whether this container should allocate a buffer for stdin in the container runtime.Boolean
getStdinOnce()
Whether the container runtime should close the stdin channel after it has been opened by a single attach.String
getTargetContainerName()
If set, the name of the container from PodSpec that this ephemeral container targets.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.String
getTerminationMessagePolicy()
Indicate how the termination message should be populated.Boolean
getTty()
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.List<VolumeDevice>
getVolumeDevices()
volumeDevices is the list of block devices to be used by the container.List<VolumeMount>
getVolumeMounts()
Pod volumes to mount into the container's filesystem.String
getWorkingDir()
Container's working directory.int
hashCode()
-
-
-
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(EphemeralContainer.Builder builder)
Constructor that initializes the object based on literal property values passed by theEphemeralContainer.Builder
.
-
-
Method Detail
-
getName
public final String getName()
Description copied from interface:EphemeralContainer
Name of the ephemeral container specified as a DNS_LABEL.This name must be unique among all containers, init containers and ephemeral containers.
- Specified by:
getName
in interfaceEphemeralContainer
-
getArgs
public final List<String> getArgs()
Description copied from interface:EphemeralContainer
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
- Specified by:
getArgs
in interfaceEphemeralContainer
-
getCommand
public final List<String> getCommand()
Description copied from interface:EphemeralContainer
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
- Specified by:
getCommand
in interfaceEphemeralContainer
-
getEnv
public final List<EnvVar> getEnv()
Description copied from interface:EphemeralContainer
List of environment variables to set in the container.Cannot be updated.
- Specified by:
getEnv
in interfaceEphemeralContainer
-
getEnvFrom
public final List<EnvFromSource> getEnvFrom()
Description copied from interface:EphemeralContainer
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.
- Specified by:
getEnvFrom
in interfaceEphemeralContainer
-
getImage
public final String getImage()
Description copied from interface:EphemeralContainer
Container image name.More info: https://kubernetes.io/docs/concepts/containers/images
- Specified by:
getImage
in interfaceEphemeralContainer
-
getImagePullPolicy
public final String getImagePullPolicy()
Description copied from interface:EphemeralContainer
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
- Specified by:
getImagePullPolicy
in interfaceEphemeralContainer
-
getLifecycle
public final Lifecycle getLifecycle()
Description copied from interface:EphemeralContainer
Lifecycle is not allowed for ephemeral containers.- Specified by:
getLifecycle
in interfaceEphemeralContainer
-
getLivenessProbe
public final Probe getLivenessProbe()
Description copied from interface:EphemeralContainer
Probes are not allowed for ephemeral containers.- Specified by:
getLivenessProbe
in interfaceEphemeralContainer
-
getPorts
public final List<ContainerPort> getPorts()
Description copied from interface:EphemeralContainer
Ports are not allowed for ephemeral containers.- Specified by:
getPorts
in interfaceEphemeralContainer
-
getReadinessProbe
public final Probe getReadinessProbe()
Description copied from interface:EphemeralContainer
Probes are not allowed for ephemeral containers.- Specified by:
getReadinessProbe
in interfaceEphemeralContainer
-
getResources
public final ResourceRequirements getResources()
Description copied from interface:EphemeralContainer
Resources are not allowed for ephemeral containers.Ephemeral containers use spare resources already allocated to the pod.
- Specified by:
getResources
in interfaceEphemeralContainer
-
getSecurityContext
public final SecurityContext getSecurityContext()
Description copied from interface:EphemeralContainer
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.
- Specified by:
getSecurityContext
in interfaceEphemeralContainer
-
getStartupProbe
public final Probe getStartupProbe()
Description copied from interface:EphemeralContainer
Probes are not allowed for ephemeral containers.- Specified by:
getStartupProbe
in interfaceEphemeralContainer
-
getStdin
public final Boolean getStdin()
Description copied from interface:EphemeralContainer
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.
- Specified by:
getStdin
in interfaceEphemeralContainer
-
getStdinOnce
public final Boolean getStdinOnce()
Description copied from interface:EphemeralContainer
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
- Specified by:
getStdinOnce
in interfaceEphemeralContainer
-
getTargetContainerName
public final String getTargetContainerName()
Description copied from interface:EphemeralContainer
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.
- Specified by:
getTargetContainerName
in interfaceEphemeralContainer
-
getTerminationMessagePath
public final String getTerminationMessagePath()
Description copied from interface:EphemeralContainer
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.
- Specified by:
getTerminationMessagePath
in interfaceEphemeralContainer
-
getTerminationMessagePolicy
public final String getTerminationMessagePolicy()
Description copied from interface:EphemeralContainer
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.
- Specified by:
getTerminationMessagePolicy
in interfaceEphemeralContainer
-
getTty
public final Boolean getTty()
Description copied from interface:EphemeralContainer
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.Default is false.
Default: false.
- Specified by:
getTty
in interfaceEphemeralContainer
-
getVolumeDevices
public final List<VolumeDevice> getVolumeDevices()
Description copied from interface:EphemeralContainer
volumeDevices is the list of block devices to be used by the container.- Specified by:
getVolumeDevices
in interfaceEphemeralContainer
-
getVolumeMounts
public final List<VolumeMount> getVolumeMounts()
Description copied from interface:EphemeralContainer
Pod volumes to mount into the container's filesystem.Subpath mounts are not allowed for ephemeral containers. Cannot be updated.
- Specified by:
getVolumeMounts
in interfaceEphemeralContainer
-
getWorkingDir
public final String getWorkingDir()
Description copied from interface:EphemeralContainer
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.
- Specified by:
getWorkingDir
in interfaceEphemeralContainer
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
-