org.cdk8s.plus20

Interface ContainerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ContainerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.41.0 (build a274beb)",
           date="2021-10-28T21:51:42.863Z")
 @Stability(value=Stable)
public interface ContainerProps
extends software.amazon.jsii.JsiiSerializable

Properties for creating a container.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ContainerProps.Builder A builder for ContainerProps
static class	ContainerProps.Jsii$Proxy An implementation for ContainerProps

Method Summary

Modifier and Type	Method and Description
static ContainerProps.Builder	builder()
default List<String>	getArgs() Arguments to the entrypoint.
default List<String>	getCommand() Entrypoint array.
default Map<String,EnvValue>	getEnv() List of environment variables to set in the container.
String	getImage() Docker image name.
default ImagePullPolicy	getImagePullPolicy() Image pull policy for this container.
default Probe	getLiveness() Periodic probe of container liveness.
default String	getName() Name of the container specified as a DNS_LABEL.
default Number	getPort() Number of port to expose on the pod's IP address.
default Probe	getReadiness() Determines when the container is ready to serve traffic.
default Probe	getStartup() StartupProbe indicates that the Pod has successfully initialized.
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

getImage

@Stability(value=Stable)
 @NotNull
String getImage()

Docker image name.

getArgs

@Stability(value=Stable)
 @Nullable
default List<String> getArgs()

Arguments to the entrypoint. The docker image's CMD is used if `command` 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.

Cannot be updated.

Default: []

See Also:

https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

getCommand

@Stability(value=Stable)
 @Nullable
default List<String> getCommand()

Entrypoint array.

Not executed within a shell. The docker 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. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(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

Default: - The docker image's ENTRYPOINT.

getEnv

@Stability(value=Stable)
 @Nullable
default Map<String,EnvValue> getEnv()

List of environment variables to set in the container.

Cannot be updated.

Default: - No environment variables.

getImagePullPolicy

@Stability(value=Stable)
 @Nullable
default ImagePullPolicy getImagePullPolicy()

Image pull policy for this container.

Default: ImagePullPolicy.ALWAYS

getLiveness

@Stability(value=Stable)
 @Nullable
default Probe getLiveness()

Periodic probe of container liveness.

Container will be restarted if the probe fails.

Default: - no liveness probe is defined

getName

@Stability(value=Stable)
 @Nullable
default 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.

Default: 'main'

getPort

@Stability(value=Stable)
 @Nullable
default Number getPort()

Number of port to expose on the pod's IP address.

This must be a valid port number, 0 < x < 65536.

Default: - No port is exposed.

getReadiness

@Stability(value=Stable)
 @Nullable
default Probe getReadiness()

Determines when the container is ready to serve traffic.

Default: - no readiness probe is defined

getStartup

@Stability(value=Stable)
 @Nullable
default Probe getStartup()

StartupProbe indicates that the Pod has successfully initialized.

If specified, no other probes are executed until this completes successfully

Default: - no startup probe is defined.

getVolumeMounts

@Stability(value=Stable)
 @Nullable
default List<VolumeMount> getVolumeMounts()

Pod volumes to mount into the container's filesystem.

Cannot be updated.

getWorkingDir

@Stability(value=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.

Default: - The container runtime's default.

builder

@Stability(value=Stable)
static ContainerProps.Builder builder()

Returns:

a ContainerProps.Builder of ContainerProps