Package io.quarkus.amazon.common.runtime

Interface DevServicesBuildTimeConfig

public interface DevServicesBuildTimeConfig

Method Summary

Modifier and Type	Method	Description
Map<String,String>	containerProperties()	Generic properties that are pass for additional container configuration.
Optional<Boolean>	enabled()	If a local AWS stack should be used.
boolean	isolated()	Indicates if shared LocalStack services managed by Dev Services should be isolated.
String	serviceName()	The value of the quarkus-dev-service-localstack label attached to the started container.
boolean	shared()	Indicates if the LocalStack container managed by Dev Services is shared.

Method Details

enabled

Optional<Boolean> enabled()

If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto

shared

@WithDefault("false")
boolean shared()

Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container.

The discovery uses the quarkus-dev-service-localstack label. The value is configured using the service-name property.

Sharing is not supported for the Cognito extension.

isolated

@WithDefault("true")
boolean isolated()

Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the quarkus-dev-service-localstack label will be suffixed by the service name (s3, sqs, ...)

serviceName

@WithDefault("localstack")
String serviceName()

The value of the quarkus-dev-service-localstack label attached to the started container. In dev mode, when shared is set to true, before starting a container, Dev Services looks for a container with the quarkus-dev-service-localstack label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the quarkus-dev-service-localstack label set to the specified value. In test mode, Dev Services will group services with the same service-name value in one container instance.

This property is used when you need multiple shared LocalStack instances.

containerProperties

Map<String,String> containerProperties()

Generic properties that are pass for additional container configuration.