Package io.github.cdklabs.projen.circleci

Interface Docker

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Docker.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.060Z")
@Stability(Experimental)
public interface Docker
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for docker executor.

See Also:

https://circleci.com/docs/2.0/configuration-reference/#docker

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Docker.Builder	A builder for Docker
static class	Docker.Jsii$Proxy	An implementation for Docker

Method Summary

Modifier and Type	Method	Description
static Docker.Builder	builder()
default Map<String,String>	getAuth()	(experimental) Authentication for registries using standard docker login credentials.
default Map<String,String>	getAwsAuth()	(experimental) Authentication for AWS Elastic Container Registry (ECR).
default List<String>	getCommand()	(experimental) The command used as pid 1 (or args for entrypoint) when launching the container.
default List<String>	getEntrypoint()	(experimental) The command used as executable when launching the container.
default Map<String,Object>	getEnvironment()	(experimental) A map of environment variable names and values.
String	getImage()	(experimental) The name of a custom docker image to use.
default String	getName()	(experimental) The name the container is reachable by.
default String	getUser()	(experimental) Which user to run commands as within the Docker container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getImage

@Stability(Experimental)
@NotNull
String getImage()

(experimental) The name of a custom docker image to use.

getAuth

@Stability(Experimental)
@Nullable
default Map<String,String> getAuth()

(experimental) Authentication for registries using standard docker login credentials.

getAwsAuth

@Stability(Experimental)
@Nullable
default Map<String,String> getAwsAuth()

(experimental) Authentication for AWS Elastic Container Registry (ECR).

getCommand

@Stability(Experimental)
@Nullable
default List<String> getCommand()

(experimental) The command used as pid 1 (or args for entrypoint) when launching the container.

getEntrypoint

@Stability(Experimental)
@Nullable
default List<String> getEntrypoint()

(experimental) The command used as executable when launching the container.

getEnvironment

@Stability(Experimental)
@Nullable
default Map<String,Object> getEnvironment()

(experimental) A map of environment variable names and values.

getName

@Stability(Experimental)
@Nullable
default String getName()

(experimental) The name the container is reachable by.

By default, container services are accessible through localhost

getUser

@Stability(Experimental)
@Nullable
default String getUser()

(experimental) Which user to run commands as within the Docker container.

builder

@Stability(Experimental)
static Docker.Builder builder()

Returns:

a Docker.Builder of Docker