Package io.github.cdklabs.projen
Class DockerComposeService.Builder
- java.lang.Object
-
- io.github.cdklabs.projen.DockerComposeService.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<DockerComposeService>
- Enclosing class:
- DockerComposeService
@Stability(Experimental) public static final class DockerComposeService.Builder extends Object implements software.amazon.jsii.Builder<DockerComposeService>
(experimental) A fluent builder forDockerComposeService.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DockerComposeServicebuild()DockerComposeService.Buildercommand(List<String> command)(experimental) Provide a command to the docker container.static DockerComposeService.Buildercreate(String serviceName)DockerComposeService.BuilderdependsOn(List<? extends IDockerComposeServiceName> dependsOn)(experimental) Names of other services this service depends on.DockerComposeService.Builderentrypoint(List<String> entrypoint)(experimental) Entrypoint to run in the container.DockerComposeService.Builderenvironment(Map<String,String> environment)(experimental) Add environment variables.DockerComposeService.Builderimage(String image)(experimental) Use a docker image.DockerComposeService.BuilderimageBuild(DockerComposeBuild imageBuild)(experimental) Build a docker image.DockerComposeService.Builderlabels(Map<String,String> labels)(experimental) Add labels.DockerComposeService.Buildernetworks(List<? extends IDockerComposeNetworkBinding> networks)(experimental) Add some networks to the service.DockerComposeService.Builderplatform(String platform)(experimental) Add platform.DockerComposeService.Builderports(List<? extends DockerComposeServicePort> ports)(experimental) Map some ports.DockerComposeService.Buildervolumes(List<? extends IDockerComposeVolumeBinding> volumes)(experimental) Mount some volumes into the service.
-
-
-
Method Detail
-
create
@Stability(Experimental) public static DockerComposeService.Builder create(String serviceName)
- Parameters:
serviceName- The name of the docker compose service. This parameter is required.- Returns:
- a new instance of
DockerComposeService.Builder.
-
command
@Stability(Experimental) public DockerComposeService.Builder command(List<String> command)
(experimental) Provide a command to the docker container.Default: - use the container's default command
- Parameters:
command- Provide a command to the docker container. This parameter is required.- Returns:
this
-
dependsOn
@Stability(Experimental) public DockerComposeService.Builder dependsOn(List<? extends IDockerComposeServiceName> dependsOn)
(experimental) Names of other services this service depends on.Default: - no dependencies
- Parameters:
dependsOn- Names of other services this service depends on. This parameter is required.- Returns:
this
-
entrypoint
@Stability(Experimental) public DockerComposeService.Builder entrypoint(List<String> entrypoint)
(experimental) Entrypoint to run in the container.- Parameters:
entrypoint- Entrypoint to run in the container. This parameter is required.- Returns:
this
-
environment
@Stability(Experimental) public DockerComposeService.Builder environment(Map<String,String> environment)
(experimental) Add environment variables.Default: - no environment variables are provided
- Parameters:
environment- Add environment variables. This parameter is required.- Returns:
this
-
image
@Stability(Experimental) public DockerComposeService.Builder image(String image)
(experimental) Use a docker image.Note: You must specify either
buildorimagekey.- Parameters:
image- Use a docker image. This parameter is required.- Returns:
this- See Also:
- imageBuild
-
imageBuild
@Stability(Experimental) public DockerComposeService.Builder imageBuild(DockerComposeBuild imageBuild)
(experimental) Build a docker image.Note: You must specify either
imageBuildorimagekey.- Parameters:
imageBuild- Build a docker image. This parameter is required.- Returns:
this- See Also:
- image
-
labels
@Stability(Experimental) public DockerComposeService.Builder labels(Map<String,String> labels)
(experimental) Add labels.Default: - no labels are provided
- Parameters:
labels- Add labels. This parameter is required.- Returns:
this
-
networks
@Stability(Experimental) public DockerComposeService.Builder networks(List<? extends IDockerComposeNetworkBinding> networks)
(experimental) Add some networks to the service.- Parameters:
networks- Add some networks to the service. This parameter is required.- Returns:
this- See Also:
- DockerCompose.network () to create & mount a named network
-
platform
@Stability(Experimental) public DockerComposeService.Builder platform(String platform)
(experimental) Add platform.Default: - no platform is provided
- Parameters:
platform- Add platform. This parameter is required.- Returns:
this
-
ports
@Stability(Experimental) public DockerComposeService.Builder ports(List<? extends DockerComposeServicePort> ports)
(experimental) Map some ports.Default: - no ports are mapped
- Parameters:
ports- Map some ports. This parameter is required.- Returns:
this
-
volumes
@Stability(Experimental) public DockerComposeService.Builder volumes(List<? extends IDockerComposeVolumeBinding> volumes)
(experimental) Mount some volumes into the service.Use one of the following to create volumes:
- Parameters:
volumes- Mount some volumes into the service. This parameter is required.- Returns:
this- See Also:
- DockerCompose.namedVolume () to create & mount a named volume
-
build
@Stability(Experimental) public DockerComposeService build()
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<DockerComposeService>- Returns:
- a newly built instance of
DockerComposeService.
-
-