Package io.github.cdklabs.projen.vscode

Class DevContainer.Builder

java.lang.Object

io.github.cdklabs.projen.vscode.DevContainer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DevContainer>

Enclosing class:

DevContainer

@Stability(Experimental)
public static final class DevContainer.Builder
extends Object
implements software.amazon.jsii.Builder<DevContainer>

(experimental) A fluent builder for DevContainer.

Method Summary

Modifier and Type	Method	Description
DevContainer	build()
static DevContainer.Builder	create(Project project)
DevContainer.Builder	dockerImage(DevEnvironmentDockerImage dockerImage)	(experimental) A Docker image or Dockerfile for the container.
DevContainer.Builder	features(List<? extends DevContainerFeature> features)	(experimental) An array of VSCode features that specify the features that should be installed inside the container when it is created.
DevContainer.Builder	ports(List<String> ports)	(experimental) An array of ports that should be exposed from the container.
DevContainer.Builder	tasks(List<? extends Task> tasks)	(experimental) An array of tasks that should be run when the container starts.
DevContainer.Builder	vscodeExtensions(List<String> vscodeExtensions)	(experimental) An array of extension IDs that specify the extensions that should be installed inside the container when it is created.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static DevContainer.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of DevContainer.Builder.

dockerImage

@Stability(Experimental)
public DevContainer.Builder dockerImage(DevEnvironmentDockerImage dockerImage)

(experimental) A Docker image or Dockerfile for the container.

Parameters:

dockerImage - A Docker image or Dockerfile for the container. This parameter is required.

Returns:

this

ports

@Stability(Experimental)
public DevContainer.Builder ports(List<String> ports)

(experimental) An array of ports that should be exposed from the container.

Parameters:

ports - An array of ports that should be exposed from the container. This parameter is required.

Returns:

this

tasks

@Stability(Experimental)
public DevContainer.Builder tasks(List<? extends Task> tasks)

(experimental) An array of tasks that should be run when the container starts.

Parameters:

tasks - An array of tasks that should be run when the container starts. This parameter is required.

Returns:

this

vscodeExtensions

@Stability(Experimental)
public DevContainer.Builder vscodeExtensions(List<String> vscodeExtensions)

(experimental) An array of extension IDs that specify the extensions that should be installed inside the container when it is created.

Parameters:

vscodeExtensions - An array of extension IDs that specify the extensions that should be installed inside the container when it is created. This parameter is required.

Returns:

this

features

@Stability(Experimental)
public DevContainer.Builder features(List<? extends DevContainerFeature> features)

(experimental) An array of VSCode features that specify the features that should be installed inside the container when it is created.

Parameters:

features - An array of VSCode features that specify the features that should be installed inside the container when it is created. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public DevContainer build()

Specified by:

build in interface software.amazon.jsii.Builder<DevContainer>

Returns:

a newly built instance of DevContainer.