DockerImageSource

class aws_cdk.cloud_assembly_schema.DockerImageSource(*, directory=None, docker_build_args=None, docker_build_target=None, docker_file=None, executable=None)

Bases: object

Properties for how to produce a Docker image from a source.

Parameters
  • directory (Optional[str]) – The directory containing the Docker image build instructions. This path is relative to the asset manifest location. Default: - Exactly one of directory and executable is required

  • docker_build_args (Optional[Mapping[str, str]]) – Additional build arguments. Only allowed when directory is set. Default: - No additional build arguments

  • docker_build_target (Optional[str]) – Target build stage in a Dockerfile with multiple build stages. Only allowed when directory is set. Default: - The last stage in the Dockerfile

  • docker_file (Optional[str]) – The name of the file with build instructions. Only allowed when directory is set. Default: “Dockerfile”

  • executable (Optional[List[str]]) – A command-line executable that returns the name of a local Docker image on stdout after being run. Default: - Exactly one of directory and executable is required

Attributes

directory

The directory containing the Docker image build instructions.

This path is relative to the asset manifest location.

Default
  • Exactly one of directory and executable is required

Return type

Optional[str]

docker_build_args

Additional build arguments.

Only allowed when directory is set.

Default
  • No additional build arguments

Return type

Optional[Mapping[str, str]]

docker_build_target

Target build stage in a Dockerfile with multiple build stages.

Only allowed when directory is set.

Default
  • The last stage in the Dockerfile

Return type

Optional[str]

docker_file

The name of the file with build instructions.

Only allowed when directory is set.

Default

“Dockerfile”

Return type

Optional[str]

executable

A command-line executable that returns the name of a local Docker image on stdout after being run.

Default
  • Exactly one of directory and executable is required

Return type

Optional[List[str]]