Package io.github.cdklabs.cdkpipelines.github

Interface ContainerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ContainerOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.62.0 (build 293ac17)",
           date="2022-07-16T00:20:23.444Z")
@Stability(Stable)
public interface ContainerOptions
extends software.amazon.jsii.JsiiSerializable

Options petaining to container environments.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ContainerOptions.Builder	builder()
default ContainerCredentials	getCredentials()	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()	Sets a map of environment variables in the container.
String	getImage()	The Docker image to use as the container to run the action.
default List<String>	getOptions()	Additional Docker container resource options.
default List<Number>	getPorts()	Sets an array of ports to expose on the container.
default List<String>	getVolumes()	Sets an array of volumes for the container to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getImage

@Stability(Stable)
@NotNull
String getImage()

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(Stable)
@Nullable
default ContainerCredentials getCredentials()

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(Stable)
@Nullable
default Map<String,String> getEnv()

Sets a map of environment variables in the container.

getOptions

@Stability(Stable)
@Nullable
default List<String> getOptions()

Additional Docker container resource options.

See Also:

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

getPorts

@Stability(Stable)
@Nullable
default List<Number> getPorts()

Sets an array of ports to expose on the container.

getVolumes

@Stability(Stable)
@Nullable
default List<String> getVolumes()

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(Stable)
static ContainerOptions.Builder builder()

Returns:

a ContainerOptions.Builder of ContainerOptions