Package io.github.cdklabs.projen
Interface IDevEnvironment
-
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
IDevContainerEnvironment,IDevContainerEnvironment.Jsii$Default,IDevEnvironment.Jsii$Default
- All Known Implementing Classes:
DevContainer,Gitpod,IDevContainerEnvironment.Jsii$Proxy,IDevEnvironment.Jsii$Proxy
@Generated(value="jsii-pacmak/1.96.0 (build 921e240)", date="2024-03-28T21:16:42.760Z") @Stability(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 Description static interfaceIDevEnvironment.Jsii$DefaultInternal default implementation forIDevEnvironment.static classIDevEnvironment.Jsii$ProxyA proxy class which represents a concrete javascript instance of this type.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddDockerImage(DevEnvironmentDockerImage image)(experimental) Add a custom Docker image or Dockerfile for the container.voidaddPorts(@NotNull String... ports)(experimental) Adds ports that should be exposed (forwarded) from the container.voidaddTasks(@NotNull Task... tasks)(experimental) Adds tasks to run when the container starts.voidaddVscodeExtensions(@NotNull String... extensions)(experimental) Adds a list of VSCode extensions that should be automatically installed in the container.
-
-
-
Method Detail
-
addDockerImage
@Stability(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(Experimental) void addPorts(@NotNull @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(Experimental) void addTasks(@NotNull @NotNull Task... tasks)(experimental) Adds tasks to run when the container starts.- Parameters:
tasks- The new tasks. This parameter is required.
-
addVscodeExtensions
@Stability(Experimental) void addVscodeExtensions(@NotNull @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.
-
-