Package io.github.cdklabs.projen

Class DevEnvironmentDockerImage

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.DevEnvironmentDockerImage

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.737Z")
@Stability(Experimental)
public class DevEnvironmentDockerImage
extends software.amazon.jsii.JsiiObject

(experimental) Options for specifying the Docker image of the container.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DevEnvironmentDockerImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DevEnvironmentDockerImage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static DevEnvironmentDockerImage	fromFile(String dockerFile)	(experimental) The relative path of a Dockerfile that defines the container contents.
static DevEnvironmentDockerImage	fromImage(String image)	(experimental) A publicly available Docker image.
String	getDockerFile()	(experimental) The relative path of a Dockerfile that defines the container contents.
String	getImage()	(experimental) A publicly available Docker image.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, 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

DevEnvironmentDockerImage

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

DevEnvironmentDockerImage

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

Method Detail

fromFile

@Stability(Experimental)
@NotNull
public static DevEnvironmentDockerImage fromFile(@NotNull
                                                 String dockerFile)

(experimental) The relative path of a Dockerfile that defines the container contents.

Example:

 '.gitpod.Docker'
 

Parameters:

dockerFile - a relative path. This parameter is required.

fromImage

@Stability(Experimental)
@NotNull
public static DevEnvironmentDockerImage fromImage(@NotNull
                                                  String image)

(experimental) A publicly available Docker image.

Example:

 'ubuntu:latest'
 

Parameters:

image - a Docker image. This parameter is required.

getDockerFile

@Stability(Experimental)
@Nullable
public String getDockerFile()

(experimental) The relative path of a Dockerfile that defines the container contents.

getImage

@Stability(Experimental)
@Nullable
public String getImage()

(experimental) A publicly available Docker image.