io.github.cdklabs.projen

Interface IDevEnvironment

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDevEnvironment.Jsii$Default

All Known Implementing Classes:

DevContainer, Gitpod, IDevEnvironment.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.403Z")
 @Stability(value=Experimental)
public interface IDevEnvironment
extends software.amazon.jsii.JsiiSerializable

(experimental) Abstract interface for container-based development environments, such as Gitpod and GitHub Codespaces.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDevEnvironment.Jsii$Default Internal default implementation for IDevEnvironment.
static class	IDevEnvironment.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
void	addDockerImage(DevEnvironmentDockerImage image) (experimental) Add a custom Docker image or Dockerfile for the container.
void	addPorts(String... ports) (experimental) Adds ports that should be exposed (forwarded) from the container.
void	addTasks(Task... tasks) (experimental) Adds tasks to run when the container starts.
void	addVscodeExtensions(String... extensions) (experimental) Adds a list of VSCode extensions that should be automatically installed in the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

addDockerImage

@Stability(value=Experimental)
void addDockerImage(@NotNull
                                                   DevEnvironmentDockerImage image)

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

Parameters:

image - The Docker image. This parameter is required.

addPorts

@Stability(value=Experimental)
void addPorts(@NotNull
                                             String... ports)

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

Parameters:

ports - The new ports. This parameter is required.

addTasks

@Stability(value=Experimental)
void addTasks(@NotNull
                                             Task... tasks)

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

Parameters:

tasks - The new tasks. This parameter is required.

addVscodeExtensions

@Stability(value=Experimental)
void addVscodeExtensions(@NotNull
                                                        String... extensions)

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

Parameters:

extensions - The extension IDs. This parameter is required.