io.github.cdklabs.projen.github.workflows

Interface ContainerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ContainerOptions.Jsii$Proxy

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

(experimental) Options petaining to container environments.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ContainerOptions.Builder	builder()
default ContainerCredentials	getCredentials() (experimental) f the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password.
default Map<String,String>	getEnv() (experimental) Sets a map of environment variables in the container.
String	getImage() (experimental) The Docker image to use as the container to run the action.
default List<String>	getOptions() (experimental) Additional Docker container resource options.
default List<Number>	getPorts() (experimental) Sets an array of ports to expose on the container.
default List<String>	getVolumes() (experimental) Sets an array of volumes for the container to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getImage

@Stability(value=Experimental)
 @NotNull
String getImage()

(experimental) The Docker image to use as the container to run the action.

The value can be the Docker Hub image name or a registry name.

getCredentials

@Stability(value=Experimental)
 @Nullable
default ContainerCredentials getCredentials()

(experimental) f the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password.

The credentials are the same values that you would provide to the docker login command.

getEnv

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getEnv()

(experimental) Sets a map of environment variables in the container.

getOptions

@Stability(value=Experimental)
 @Nullable
default List<String> getOptions()

(experimental) Additional Docker container resource options.

See Also:

https://docs.docker.com/engine/reference/commandline/create/#options

getPorts

@Stability(value=Experimental)
 @Nullable
default List<Number> getPorts()

(experimental) Sets an array of ports to expose on the container.

getVolumes

@Stability(value=Experimental)
 @Nullable
default List<String> getVolumes()

(experimental) Sets an array of volumes for the container to use.

You can use volumes to share data between services or other steps in a job. You can specify named Docker volumes, anonymous Docker volumes, or bind mounts on the host.

To specify a volume, you specify the source and destination path: <source>:<destinationPath>.

builder

@Stability(value=Experimental)
static ContainerOptions.Builder builder()

Returns:

a ContainerOptions.Builder of ContainerOptions