Class EmulatorRuntimeConfiguration
java.lang.Object
io.github.gregwhitaker.awsemulator.emulator.EmulatorRuntimeConfiguration
- Direct Known Subclasses:
AwsEmulatorExtension,NamedEmulatorRuntime
Connection and lifecycle settings shared by the default runtime and named runtimes.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddocker(org.gradle.api.Action<? super DockerRuntimeConfiguration> action) Configures Docker without contacting a daemon until execution.voidexternal(org.gradle.api.Action<? super ExternalEmulatorConnection> action) Enables an externally owned emulator connection.abstract org.gradle.api.provider.Property<Integer>Timeout for Docker image builds and pulls.abstract org.gradle.api.provider.Property<Integer>Timeout for ordinary Docker commands.Docker client selection and managed-runtime transport.abstract org.gradle.api.provider.Property<String>Docker command name or absolute executable path.abstract org.gradle.api.provider.Property<String>AWS Emulator package version to install when building an image.Connection to an existing emulator.abstract org.gradle.api.provider.Property<String>getImage()Optional existing Docker image; bypasses the generated Dockerfile.abstract org.gradle.api.provider.Property<String>Container memory limit in Docker's size notation, for example 2g.protected abstract org.gradle.api.model.ObjectFactoryabstract org.gradle.api.provider.Property<String>Docker platform: auto, linux/amd64, or linux/arm64.abstract org.gradle.api.provider.Property<Integer>getPort()Local endpoint port, defaulting to zero to select an available port.abstract org.gradle.api.provider.Property<String>Region supplied to resource clients and opted-in consumers.abstract org.gradle.api.provider.Property<Integer>HTTPS readiness timeout, including for external connections.abstract org.gradle.api.provider.Property<Boolean>Whether to enable the emulator's AWS telemetry.abstract org.gradle.api.file.DirectoryPropertyRuntime files, locks, and logs; use a distinct directory for each named runtime.
-
Constructor Details
-
EmulatorRuntimeConfiguration
public EmulatorRuntimeConfiguration()
-
-
Method Details
-
getObjects
@Inject protected abstract org.gradle.api.model.ObjectFactory getObjects() -
getEmulatorVersion
AWS Emulator package version to install when building an image. -
getImage
Optional existing Docker image; bypasses the generated Dockerfile. -
getPlatform
Docker platform: auto, linux/amd64, or linux/arm64. -
getPort
Local endpoint port, defaulting to zero to select an available port. DIRECT also uses it in the container. -
getRegion
Region supplied to resource clients and opted-in consumers. -
getTelemetryEnabled
Whether to enable the emulator's AWS telemetry. -
getDockerExecutable
Docker command name or absolute executable path. -
getMemoryLimit
Container memory limit in Docker's size notation, for example 2g. -
getStartupTimeoutSeconds
HTTPS readiness timeout, including for external connections. -
getCommandTimeoutSeconds
Timeout for ordinary Docker commands. -
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
Docker client selection and managed-runtime transport. -
docker
Configures Docker without contacting a daemon until execution. -
getExternal
Connection to an existing emulator. Disabled unless enabled explicitly or configured withexternal(Action). -
external
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
-