Class EmulatorRuntimeConfiguration

java.lang.Object
io.github.gregwhitaker.awsemulator.emulator.EmulatorRuntimeConfiguration
Direct Known Subclasses:
AwsEmulatorExtension, NamedEmulatorRuntime

public abstract class EmulatorRuntimeConfiguration extends Object
Connection and lifecycle settings shared by the default runtime and named runtimes.
  • Constructor Details

    • EmulatorRuntimeConfiguration

      public EmulatorRuntimeConfiguration()
  • Method Details

    • getObjects

      @Inject protected abstract org.gradle.api.model.ObjectFactory getObjects()
    • getEmulatorVersion

      public abstract org.gradle.api.provider.Property<String> getEmulatorVersion()
      AWS Emulator package version to install when building an image.
    • getImage

      public abstract org.gradle.api.provider.Property<String> getImage()
      Optional existing Docker image; bypasses the generated Dockerfile.
    • getPlatform

      public abstract org.gradle.api.provider.Property<String> getPlatform()
      Docker platform: auto, linux/amd64, or linux/arm64.
    • getPort

      public abstract org.gradle.api.provider.Property<Integer> getPort()
      Local endpoint port, defaulting to zero to select an available port. DIRECT also uses it in the container.
    • getRegion

      public abstract org.gradle.api.provider.Property<String> getRegion()
      Region supplied to resource clients and opted-in consumers.
    • getTelemetryEnabled

      public abstract org.gradle.api.provider.Property<Boolean> getTelemetryEnabled()
      Whether to enable the emulator's AWS telemetry.
    • getDockerExecutable

      public abstract org.gradle.api.provider.Property<String> getDockerExecutable()
      Docker command name or absolute executable path.
    • getMemoryLimit

      public abstract org.gradle.api.provider.Property<String> getMemoryLimit()
      Container memory limit in Docker's size notation, for example 2g.
    • getStartupTimeoutSeconds

      public abstract org.gradle.api.provider.Property<Integer> getStartupTimeoutSeconds()
      HTTPS readiness timeout, including for external connections.
    • getCommandTimeoutSeconds

      public abstract org.gradle.api.provider.Property<Integer> getCommandTimeoutSeconds()
      Timeout for ordinary Docker commands.
    • getBuildTimeoutSeconds

      public abstract org.gradle.api.provider.Property<Integer> getBuildTimeoutSeconds()
      Timeout for Docker image builds and pulls.
    • getWorkingDirectory

      public abstract org.gradle.api.file.DirectoryProperty getWorkingDirectory()
      Runtime files, locks, and logs; use a distinct directory for each named runtime.
    • getDocker

      public DockerRuntimeConfiguration getDocker()
      Docker client selection and managed-runtime transport.
    • docker

      public void docker(org.gradle.api.Action<? super DockerRuntimeConfiguration> action)
      Configures Docker without contacting a daemon until execution.
    • getExternal

      public ExternalEmulatorConnection getExternal()
      Connection to an existing emulator. Disabled unless enabled explicitly or configured with external(Action).
    • external

      public void external(org.gradle.api.Action<? super ExternalEmulatorConnection> action)
      Enables an externally owned emulator connection. Both consumer modes use this same endpoint; the plugin never starts, stops, restarts, or cleans up the external emulator. Connection files are read only when an opted-in task executes.
      Parameters:
      action - configures the HTTPS endpoint, credentials file, and CA certificate file