Interface LocalEmulatorRuntime

All Known Implementing Classes:
AbstractLocalEmulatorRuntime, LocalStackEmulatorRuntime, MiniStackEmulatorRuntime
public interface LocalEmulatorRuntime
Docker lifecycle for a local AWS emulator (MiniStack or LocalStack).

Resolve implementations via LocalEmulatorRuntimes. Metadata lives in LocalEmulatorSpec; shared defaults in LocalEmulatorDefaults.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    conflictingContainerName()
    Optional container that must be stopped first because it binds the same gateway port.
    String
    containerName()
    Stable Docker container name (for example cfc-ministack).
    URI
    healthEndpoint()
    Gateway health URL on the host (for example http://localhost:4566/_ministack/health).
    boolean
    isHealthy()
    Whether the gateway health endpoint returns HTTP 2xx.
    boolean
    isRunning()
    Whether the named container is in the running state.
    default void
    restart()
    Stop then start.
    void
    start()
    Start the emulator container and wait until isHealthy().
    void
    stop()
    Stop the emulator container if it is running.
    DeploymentTarget
    target()
    Deployment target this runtime serves.

  • Method Details

    • target

      DeploymentTarget target()
      Deployment target this runtime serves.

    • containerName

      String containerName()
      Stable Docker container name (for example cfc-ministack).

    • conflictingContainerName

      Optional<String> conflictingContainerName()
      Optional container that must be stopped first because it binds the same gateway port.

    • healthEndpoint

      URI healthEndpoint()
      Gateway health URL on the host (for example http://localhost:4566/_ministack/health).

    • start

      void start() throws IOException
      Start the emulator container and wait until isHealthy().
      Throws:
      IOException

    • stop

      void stop() throws IOException
      Stop the emulator container if it is running.
      Throws:
      IOException

    • restart

      default void restart() throws IOException
      Stop then start.
      Throws:
      IOException

    • isRunning

      boolean isRunning() throws IOException
      Whether the named container is in the running state.
      Throws:
      IOException

    • isHealthy

      boolean isHealthy()
      Whether the gateway health endpoint returns HTTP 2xx.