org.cdk8s.plus

Class Container

java.lang.Object

software.amazon.jsii.JsiiObject

org.cdk8s.plus.Container

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.13.0 (build 385c325)",
           date="2020-10-21T06:58:44.647Z")
 @Stability(value=Experimental)
public class Container
extends software.amazon.jsii.JsiiObject

(experimental) A single application container that you want to run within a pod.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Container.Builder (experimental) A fluent builder for Container.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
	Container(ContainerProps props)
protected	Container(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Container(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addEnv(String name, EnvValue value) (experimental) Add an environment value to the container.
List<String>	getArgs() (experimental) Arguments to the entrypoint.
List<String>	getCommand() (experimental) Entrypoint array (the command to execute when the container starts).
Map<String,EnvValue>	getEnv() (experimental) The environment variables for this container.
String	getImage() (experimental) The container image.
ImagePullPolicy	getImagePullPolicy() (experimental) Image pull policy for this container.
List<VolumeMount>	getMounts() (experimental) Volume mounts configured for this container.
String	getName() (experimental) The name of the container.
Number	getPort() (experimental) The port this container exposes.
String	getWorkingDir() (experimental) The working directory inside the container.
void	mount(String path, Volume volume) (experimental) Mount a volume to a specific path so that it is accessible by the container.
void	mount(String path, Volume volume, MountOptions options) (experimental) Mount a volume to a specific path so that it is accessible by the container.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Container

protected Container(software.amazon.jsii.JsiiObjectRef objRef)

Container

protected Container(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Container

@Stability(value=Experimental)
public Container(@NotNull
                                                ContainerProps props)

Parameters:

props - This parameter is required.

Method Detail

addEnv

@Stability(value=Experimental)
public void addEnv(@NotNull
                                                  String name,
                                                  @NotNull
                                                  EnvValue value)

(experimental) Add an environment value to the container.

The variable value can come from various dynamic sources such a secrets of config maps.

Parameters:

name - - The variable name. This parameter is required.

value - - The variable value. This parameter is required.

See Also:

EnvValue.fromXXX

mount

@Stability(value=Experimental)
public void mount(@NotNull
                                                 String path,
                                                 @NotNull
                                                 Volume volume,
                                                 @Nullable
                                                 MountOptions options)

(experimental) Mount a volume to a specific path so that it is accessible by the container.

Every pod that is configured to use this container will autmoatically have access to the volume.

Parameters:

path - - The desired path in the container. This parameter is required.

volume - - The volume to mount. This parameter is required.

options -

mount

@Stability(value=Experimental)
public void mount(@NotNull
                                                 String path,
                                                 @NotNull
                                                 Volume volume)

(experimental) Mount a volume to a specific path so that it is accessible by the container.

Every pod that is configured to use this container will autmoatically have access to the volume.

Parameters:

path - - The desired path in the container. This parameter is required.

volume - - The volume to mount. This parameter is required.

getEnv

@Stability(value=Experimental)
 @NotNull
public Map<String,EnvValue> getEnv()

(experimental) The environment variables for this container.

Returns a copy. To add environment variables use addEnv().

getImage

@Stability(value=Experimental)
 @NotNull
public String getImage()

(experimental) The container image.

getImagePullPolicy

@Stability(value=Experimental)
 @NotNull
public ImagePullPolicy getImagePullPolicy()

(experimental) Image pull policy for this container.

getMounts

@Stability(value=Experimental)
 @NotNull
public List<VolumeMount> getMounts()

(experimental) Volume mounts configured for this container.

getName

@Stability(value=Experimental)
 @NotNull
public String getName()

(experimental) The name of the container.

getArgs

@Stability(value=Experimental)
 @Nullable
public List<String> getArgs()

(experimental) Arguments to the entrypoint.

Returns:

a copy of the arguments array, cannot be modified.

getCommand

@Stability(value=Experimental)
 @Nullable
public List<String> getCommand()

(experimental) Entrypoint array (the command to execute when the container starts).

Returns:

a copy of the entrypoint array, cannot be modified

getPort

@Stability(value=Experimental)
 @Nullable
public Number getPort()

(experimental) The port this container exposes.

getWorkingDir

@Stability(value=Experimental)
 @Nullable
public String getWorkingDir()

(experimental) The working directory inside the container.