Package io.github.cdklabs.projen.vscode

Class DevContainer

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.vscode.DevContainer

All Implemented Interfaces:

IDevEnvironment, IDevContainerEnvironment, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.319Z")
@Stability(Experimental)
public class DevContainer
extends Component
implements IDevContainerEnvironment

(experimental) A development environment running VSCode in a container;

used by GitHub codespaces.

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.vscode.IDevContainerEnvironment

IDevContainerEnvironment.Jsii$Default, IDevContainerEnvironment.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	DevContainer(Project project)
	DevContainer(Project project, DevContainerOptions options)
protected	DevContainer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DevContainer(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addDockerImage(DevEnvironmentDockerImage image)	(experimental) Add a custom Docker image or Dockerfile for the container.
void	addFeatures(@NotNull DevContainerFeature... features)	(experimental) Adds a list of VSCode features that should be automatically installed in the container.
void	addPorts(@NotNull String... ports)	(experimental) Adds ports that should be exposed (forwarded) from the container.
void	addTasks(@NotNull Task... tasks)	(experimental) Adds tasks to run when the container starts.
void	addVscodeExtensions(@NotNull String... extensions)	(experimental) Adds a list of VSCode extensions that should be automatically installed in the container.
Object	getConfig()	(experimental) Direct access to the devcontainer configuration (escape hatch).

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

DevContainer

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

DevContainer

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

DevContainer

@Stability(Experimental)
public DevContainer(@NotNull
                    Project project,
                    @Nullable
                    DevContainerOptions options)

Parameters:

project - This parameter is required.

options -

DevContainer

@Stability(Experimental)
public DevContainer(@NotNull
                    Project project)

Parameters:

project - This parameter is required.

Method Detail

addDockerImage

@Stability(Experimental)
public void addDockerImage(@NotNull
                           DevEnvironmentDockerImage image)

(experimental) Add a custom Docker image or Dockerfile for the container.

Specified by:

addDockerImage in interface IDevEnvironment

Parameters:

image - This parameter is required.

addFeatures

@Stability(Experimental)
public void addFeatures(@NotNull
                        @NotNull DevContainerFeature... features)

(experimental) Adds a list of VSCode features that should be automatically installed in the container.

Specified by:

addFeatures in interface IDevContainerEnvironment

Parameters:

features - featureName and version(optional default: latest). This parameter is required.

addPorts

@Stability(Experimental)
public void addPorts(@NotNull
                     @NotNull String... ports)

(experimental) Adds ports that should be exposed (forwarded) from the container.

Specified by:

addPorts in interface IDevEnvironment

Parameters:

ports - The new ports. This parameter is required.

addTasks

@Stability(Experimental)
public void addTasks(@NotNull
                     @NotNull Task... tasks)

(experimental) Adds tasks to run when the container starts.

Tasks will be run in sequence.

Specified by:

addTasks in interface IDevEnvironment

Parameters:

tasks - The new tasks. This parameter is required.

addVscodeExtensions

@Stability(Experimental)
public void addVscodeExtensions(@NotNull
                                @NotNull String... extensions)

(experimental) Adds a list of VSCode extensions that should be automatically installed in the container.

Specified by:

addVscodeExtensions in interface IDevEnvironment

Parameters:

extensions - The extension IDs. This parameter is required.

getConfig

@Stability(Experimental)
@NotNull
public Object getConfig()

(experimental) Direct access to the devcontainer configuration (escape hatch).