Configuration Reference

Version:1.0.0.RC3

Aws Common Config Properties

🔗
Table 1. Configuration Properties for AWSClientConfiguration
Property Type Description

aws.client-execution-timeout

int

🔗
Table 2. Configuration Properties for AWSConfiguration
Property Type Description

aws.protocol

com.amazonaws.Protocol

aws.max-connections

int

aws.user-agent-prefix

java.lang.String

aws.user-agent-suffix

java.lang.String

aws.local-address

java.net.InetAddress

aws.proxy-host

java.lang.String

aws.proxy-port

int

aws.proxy-username

java.lang.String

aws.proxy-password

java.lang.String

aws.proxy-domain

java.lang.String

aws.proxy-workstation

java.lang.String

aws.non-proxy-hosts

java.lang.String

aws.proxy-authentication-methods

java.util.List

aws.retry-policy

com.amazonaws.retry.RetryPolicy

aws.max-error-retry

int

aws.socket-timeout

int

aws.connection-timeout

int

aws.request-timeout

int

aws.use-reaper

boolean

aws.use-throttle-retries

boolean

aws.max-consecutive-retries-before-throttling

int

aws.use-gzip

boolean

aws.signer-override

java.lang.String

aws.preemptive-basic-proxy-auth

java.lang.Boolean

aws.connection-ttl

long

aws.connection-max-idle-millis

long

aws.validate-after-inactivity-millis

int

aws.use-tcp-keep-alive

boolean

aws.dns-resolver

com.amazonaws.DnsResolver

aws.cache-response-metadata

boolean

aws.response-metadata-cache-size

int

aws.secure-random

java.security.SecureRandom

aws.use-expect-continue

boolean

Cassandra Config Properties

🔗
Table 3. Configuration Properties for CassandraConfiguration
Property Type Description

cassandra.*.cluster-name

java.lang.String

cassandra.*.port

int

cassandra.*.max-schema-agreement-wait-seconds

int

cassandra.*.protocol-version

com.datastax.driver.core.ProtocolVersion

cassandra.*.contact-point

java.lang.String

cassandra.*.contact-points

java.lang.String[]

cassandra.*.contact-points-with-ports

java.net.InetSocketAddress[]

cassandra.*.load-balancing-policy

com.datastax.driver.core.policies.LoadBalancingPolicy

cassandra.*.reconnection-policy

com.datastax.driver.core.policies.ReconnectionPolicy

cassandra.*.retry-policy

com.datastax.driver.core.policies.RetryPolicy

cassandra.*.address-translator

com.datastax.driver.core.policies.AddressTranslator

cassandra.*.timestamp-generator

com.datastax.driver.core.TimestampGenerator

cassandra.*.speculative-execution-policy

com.datastax.driver.core.policies.SpeculativeExecutionPolicy

cassandra.*.codec-registry

com.datastax.driver.core.CodecRegistry

cassandra.*.auth-provider

com.datastax.driver.core.AuthProvider

cassandra.*.compression

com.datastax.driver.core.ProtocolOptions$Compression

cassandra.*.out-metrics

java.lang.Boolean

cassandra.*.ssl

java.lang.Boolean

cassandra.*.initial-listeners

java.util.Collection

cassandra.*.out-jmxreporting

java.lang.Boolean

cassandra.*.pooling-options

com.datastax.driver.core.PoolingOptions

cassandra.*.socket-options

com.datastax.driver.core.SocketOptions

cassandra.*.query-options

com.datastax.driver.core.QueryOptions

cassandra.*.netty-options

com.datastax.driver.core.NettyOptions

Discovery Client Config Properties

🔗
Table 4. Configuration Properties for Route53AutoRegistrationConfiguration
Property Type Description

aws.route53.registration.aws-service-id

java.lang.String

Setting for service id to make easier testing.

aws.route53.registration.timeout

java.time.Duration

aws.route53.registration.fail-fast

boolean

aws.route53.registration.deregister

boolean

aws.route53.registration.enabled

boolean

aws.route53.registration.retry-count

int

aws.route53.registration.retry-delay

java.time.Duration

aws.route53.registration.health-path

java.lang.String

🔗
Table 5. Configuration Properties for ConsulConfiguration$ConsulRegistrationConfiguration
Property Type Description

consul.client.registration.tags

java.util.List

The tags for registering the service

consul.client.registration.timeout

java.time.Duration

consul.client.registration.fail-fast

boolean

consul.client.registration.deregister

boolean

consul.client.registration.enabled

boolean

consul.client.registration.retry-count

int

consul.client.registration.retry-delay

java.time.Duration

consul.client.registration.health-path

java.lang.String

🔗
Table 6. Configuration Properties for AWSParameterStoreConfiguration
Property Type Description

aws.client.system-manager.parameterstore.use-secure-parameters

boolean

This will turn on or off auto-decryption via MKS for SecureString parameters. If you set this to off you will not get unencrypted values.

aws.client.system-manager.parameterstore.root-hierarchy-path

java.lang.String

This is the default for the root hierarchy on the parameter store. If empty will default to '/config/application'.

aws.client.system-manager.parameterstore.enabled

java.lang.Boolean

Enable or disable this feature.

🔗
Table 7. Configuration Properties for EurekaConfiguration$EurekaConnectionPoolConfiguration
Property Type Description

eureka.client.pool.enabled

boolean

eureka.client.pool.max-connections

int

eureka.client.pool.max-pending-acquires

int

eureka.client.pool.acquire-timeout

java.time.Duration

🔗
Table 8. Configuration Properties for EurekaConfiguration$EurekaRegistrationConfiguration
Property Type Description

eureka.client.registration.protocol

com.amazonaws.Protocol

eureka.client.registration.max-connections

int

eureka.client.registration.user-agent-prefix

java.lang.String

eureka.client.registration.user-agent-suffix

java.lang.String

eureka.client.registration.local-address

java.net.InetAddress

eureka.client.registration.proxy-host

java.lang.String

eureka.client.registration.proxy-port

int

eureka.client.registration.proxy-username

java.lang.String

eureka.client.registration.proxy-password

java.lang.String

eureka.client.registration.proxy-domain

java.lang.String

eureka.client.registration.proxy-workstation

java.lang.String

eureka.client.registration.non-proxy-hosts

java.lang.String

eureka.client.registration.proxy-authentication-methods

java.util.List

eureka.client.registration.retry-policy

com.amazonaws.retry.RetryPolicy

eureka.client.registration.max-error-retry

int

eureka.client.registration.socket-timeout

int

eureka.client.registration.connection-timeout

int

eureka.client.registration.request-timeout

int

eureka.client.registration.client-execution-timeout

int

eureka.client.registration.use-reaper

boolean

eureka.client.registration.use-throttle-retries

boolean

eureka.client.registration.max-consecutive-retries-before-throttling

int

eureka.client.registration.use-gzip

boolean

eureka.client.registration.signer-override

java.lang.String

eureka.client.registration.preemptive-basic-proxy-auth

java.lang.Boolean

eureka.client.registration.connection-ttl

long

eureka.client.registration.connection-max-idle-millis

long

eureka.client.registration.validate-after-inactivity-millis

int

eureka.client.registration.use-tcp-keep-alive

boolean

eureka.client.registration.dns-resolver

com.amazonaws.DnsResolver

eureka.client.registration.cache-response-metadata

boolean

eureka.client.registration.response-metadata-cache-size

int

eureka.client.registration.secure-random

java.security.SecureRandom

eureka.client.registration.use-expect-continue

boolean

eureka.client.registration.secure-port

int

eureka.client.registration.port

int

eureka.client.registration.instance-id

java.lang.String

eureka.client.registration.asg-name

java.lang.String

eureka.client.registration.home-page-url

java.lang.String

eureka.client.registration.lease-info

LeaseInfo

eureka.client.registration.country-id

int

eureka.client.registration.status-page-url

java.lang.String

eureka.client.registration.health-check-url

java.lang.String

eureka.client.registration.secure-health-check-url

java.lang.String

eureka.client.registration.data-center-info

DataCenterInfo

eureka.client.registration.status

InstanceInfo$Status

eureka.client.registration.app-group-name

java.lang.String

eureka.client.registration.ip-addr

java.lang.String

eureka.client.registration.vip-address

java.lang.String

eureka.client.registration.secure-vip-address

java.lang.String

eureka.client.registration.metadata

java.util.Map

eureka.client.registration.lease-info.registration-timestamp

long

eureka.client.registration.lease-info.renewal-timestamp

long

eureka.client.registration.lease-info.eviction-timestamp

long

eureka.client.registration.lease-info.service-up-timestamp

long

eureka.client.registration.lease-info.duration-in-secs

int

eureka.client.registration.lease-info.renewal-interval-in-secs

int

eureka.client.registration.timeout

java.time.Duration

eureka.client.registration.fail-fast

boolean

eureka.client.registration.deregister

boolean

eureka.client.registration.enabled

boolean

eureka.client.registration.retry-count

int

eureka.client.registration.retry-delay

java.time.Duration

eureka.client.registration.health-path

java.lang.String

🔗
Table 9. Configuration Properties for ConsulConfiguration$ConsulConfigDiscoveryConfiguration
Property Type Description

consul.client.config.datacenter

java.lang.String

The datacenter

consul.client.config.enabled

boolean

consul.client.config.path

java.lang.String

consul.client.config.format

ConfigDiscoveryConfiguration$Format

🔗
Table 10. Configuration Properties for Route53DiscoveryConfiguration
Property Type Description

aws.route53.discovery.aws-service-id

java.lang.String

set service ID for easier testing.

aws.route53.discovery.enabled

boolean

enable/disabled this feature. Default value (true).

🔗
Table 11. Configuration Properties for ConsulConfiguration$ConsulDiscoveryConfiguration
Property Type Description

consul.client.discovery.tags

java.util.Map

The tags to use for querying

consul.client.discovery.schemes

java.util.Map

The service ID to protocol scheme

consul.client.discovery.datacenters

java.util.Map

The data centers to query

consul.client.discovery.passing

boolean

Whether services that are not passing health checks should be returned

consul.client.discovery.enabled

boolean

🔗
Table 12. Configuration Properties for ConsulConfiguration$ConsulConnectionPoolConfiguration
Property Type Description

consul.client.pool.enabled

boolean

consul.client.pool.max-connections

int

consul.client.pool.max-pending-acquires

int

consul.client.pool.acquire-timeout

java.time.Duration

🔗
Table 13. Configuration Properties for EurekaConfiguration$EurekaDiscoveryConfiguration
Property Type Description

eureka.client.discovery.use-secure-port

boolean

Sets whether the secure port is used for communication.

eureka.client.discovery.enabled

boolean

🔗
Table 14. Configuration Properties for DiscoveryClientCacheConfiguration
Property Type Description

micronaut.caches.*.discovery-client.enabled

boolean

Enable or disable the discovery client

🔗
Table 15. Configuration Properties for ConsulConfiguration$ConsulRegistrationConfiguration$CheckConfiguration
Property Type Description

consul.client.registration.check.method

HttpMethod

The HTTP method to be used for an HTTP check.

consul.client.registration.check.interval

java.time.Duration

Default value (15).

consul.client.registration.check.headers

java.util.Map

Headers for the HTTP checks

consul.client.registration.check.deregister-critical-service-after

java.time.Duration

Specifies that checks associated with a service should deregister after this time

consul.client.registration.check.notes

java.lang.String

Arbitrary information for humans

consul.client.registration.check.id

java.lang.String

The unique ID for this check on the node

consul.client.registration.check.tls-skip-verify

java.lang.Boolean

Specifies if the certificate for an HTTPS check should not be verified.

consul.client.registration.check.enabled

boolean

Default value (true).

consul.client.registration.check.http

boolean

Default value (false).

🔗
Table 16. Configuration Properties for Route53ClientDiscoveryConfiguration
Property Type Description

aws.route53.discovery.client.aws-service-id

java.lang.String

set service id for easier testing.

aws.route53.discovery.client.namespace-id

java.lang.String

allows you to override the namespace id for testing.

aws.route53.discovery.client.ssl-configuration

SslConfiguration

aws.route53.discovery.client.logger-name

java.lang.String

aws.route53.discovery.client.follow-redirects

boolean

aws.route53.discovery.client.default-charset

java.nio.charset.Charset

aws.route53.discovery.client.channel-options

java.util.Map

aws.route53.discovery.client.shutdown-timeout

java.time.Duration

aws.route53.discovery.client.read-timeout

java.time.Duration

aws.route53.discovery.client.read-idle-timeout

java.time.Duration

aws.route53.discovery.client.connect-timeout

java.time.Duration

aws.route53.discovery.client.num-of-threads

java.lang.Integer

aws.route53.discovery.client.thread-factory

java.lang.Class

aws.route53.discovery.client.max-content-length

int

aws.route53.discovery.client.proxy-type

java.net.Proxy$Type

aws.route53.discovery.client.proxy-address

java.net.SocketAddress

aws.route53.discovery.client.proxy-username

java.lang.String

aws.route53.discovery.client.proxy-password

java.lang.String

aws.route53.discovery.client.default-zone

java.util.List

Sets the Discovery servers to use for the default zone.

aws.route53.discovery.client.zones

java.util.Map

Configures Discovery servers in other zones.

aws.route53.discovery.client.secure

boolean

Set if the discovery server is exposed over HTTPS

aws.route53.discovery.client.host

java.lang.String

The Discovery server host name

aws.route53.discovery.client.port

int

The port for the Discovery server

🔗
Table 17. Configuration Properties for ConsulConfiguration
Property Type Description

consul.client.asl-token

java.lang.String

The asl token

consul.client.ssl-configuration

SslConfiguration

consul.client.logger-name

java.lang.String

consul.client.follow-redirects

boolean

consul.client.default-charset

java.nio.charset.Charset

consul.client.channel-options

java.util.Map

consul.client.shutdown-timeout

java.time.Duration

consul.client.read-timeout

java.time.Duration

consul.client.read-idle-timeout

java.time.Duration

consul.client.connect-timeout

java.time.Duration

consul.client.num-of-threads

java.lang.Integer

consul.client.thread-factory

java.lang.Class

consul.client.max-content-length

int

consul.client.proxy-type

java.net.Proxy$Type

consul.client.proxy-address

java.net.SocketAddress

consul.client.proxy-username

java.lang.String

consul.client.proxy-password

java.lang.String

consul.client.default-zone

java.util.List

Sets the Discovery servers to use for the default zone.

consul.client.zones

java.util.Map

Configures Discovery servers in other zones.

consul.client.secure

boolean

Set if the discovery server is exposed over HTTPS

consul.client.host

java.lang.String

The Discovery server host name

consul.client.port

int

The port for the Discovery server

🔗
Table 18. Configuration Properties for EurekaConfiguration
Property Type Description

eureka.client.ssl-configuration

SslConfiguration

eureka.client.logger-name

java.lang.String

eureka.client.follow-redirects

boolean

eureka.client.default-charset

java.nio.charset.Charset

eureka.client.channel-options

java.util.Map

eureka.client.shutdown-timeout

java.time.Duration

eureka.client.read-timeout

java.time.Duration

eureka.client.read-idle-timeout

java.time.Duration

eureka.client.connect-timeout

java.time.Duration

eureka.client.num-of-threads

java.lang.Integer

eureka.client.thread-factory

java.lang.Class

eureka.client.max-content-length

int

eureka.client.proxy-type

java.net.Proxy$Type

eureka.client.proxy-address

java.net.SocketAddress

eureka.client.proxy-username

java.lang.String

eureka.client.proxy-password

java.lang.String

eureka.client.default-zone

java.util.List

Sets the Discovery servers to use for the default zone.

eureka.client.zones

java.util.Map

Configures Discovery servers in other zones.

eureka.client.secure

boolean

Set if the discovery server is exposed over HTTPS

eureka.client.host

java.lang.String

The Discovery server host name

eureka.client.port

int

The port for the Discovery server

Function Client Config Properties

🔗
Table 19. Configuration Properties for AWSInvokeRequestDefinition
Property Type Description

aws.lambda.functions.*.executor-factory

com.amazonaws.client.builder.ExecutorFactory

aws.lambda.functions.*.credentials

com.amazonaws.auth.AWSCredentialsProvider

aws.lambda.functions.*.client-configuration

com.amazonaws.ClientConfiguration

aws.lambda.functions.*.metrics-collector

com.amazonaws.metrics.RequestMetricCollector

aws.lambda.functions.*.region

com.amazonaws.regions.Regions

aws.lambda.functions.*.endpoint-configuration

com.amazonaws.client.builder.AwsClientBuilder$EndpointConfiguration

aws.lambda.functions.*.request-handlers

com.amazonaws.handlers.RequestHandler2[]

aws.lambda.functions.*.function-name

java.lang.String

aws.lambda.functions.*.invocation-type

java.lang.String

aws.lambda.functions.*.log-type

java.lang.String

aws.lambda.functions.*.client-context

java.lang.String

aws.lambda.functions.*.payload

java.nio.ByteBuffer

aws.lambda.functions.*.qualifier

java.lang.String

aws.lambda.functions.*.request-credentials-provider

com.amazonaws.auth.AWSCredentialsProvider

aws.lambda.functions.*.request-metric-collector

com.amazonaws.metrics.RequestMetricCollector

aws.lambda.functions.*.general-progress-listener

com.amazonaws.event.ProgressListener

aws.lambda.functions.*.sdk-request-timeout

int

aws.lambda.functions.*.sdk-client-execution-timeout

int

Hibernate Jpa Config Properties

🔗
Table 20. Configuration Properties for JpaConfiguration
Property Type Description

jpa.*.packages-to-scan

java.lang.String[]

Sets the packages to scan.

jpa.*.properties

java.util.Map

Sets the JPA properties to be passed to the JPA implementation.

Http Client Config Properties

🔗
Table 21. Configuration Properties for DefaultHttpClientConfiguration$DefaultConnectionPoolConfiguration
Property Type Description

micronaut.http.client.pool.enabled

boolean

Sets whether connection pooling is enabled. Default value (false).

micronaut.http.client.pool.max-connections

int

Sets the maximum number of connections. Defaults to no maximum.

micronaut.http.client.pool.max-pending-acquires

int

Sets the max pending acquires.

micronaut.http.client.pool.acquire-timeout

java.time.Duration

Sets the timeout to wait for a connection.

🔗
Table 22. Configuration Properties for DefaultHttpClientConfiguration
Property Type Description

micronaut.http.client.ssl-configuration

SslConfiguration

Sets the SSL configuration for the client.

micronaut.http.client.logger-name

java.lang.String

Sets the client-specific logger name.

micronaut.http.client.follow-redirects

boolean

Sets whether redirects should be followed. Default value (DEFAULT_FOLLOW_REDIRECTS).

micronaut.http.client.default-charset

java.nio.charset.Charset

Sets the default charset to use. Default value (UTF-8);

micronaut.http.client.channel-options

java.util.Map

The Netty channel options

micronaut.http.client.shutdown-timeout

java.time.Duration

Sets the amount of time to wait for shutdown of client thread pools. Default value (100 milliseconds).

micronaut.http.client.read-timeout

java.time.Duration

Sets the read timeout. Default value (10 seconds).

micronaut.http.client.read-idle-timeout

java.time.Duration

Sets the max read idle time for streaming requests. Default value (5 seconds).

micronaut.http.client.connect-timeout

java.time.Duration

Sets the connect timeout.

micronaut.http.client.num-of-threads

java.lang.Integer

Sets the number of threads the client should use for requests.

micronaut.http.client.thread-factory

java.lang.Class

Sets a thread factory.

micronaut.http.client.max-content-length

int

Sets the maximum content length the client can consume. Default value (1024 * 1024 * 10 ⇒ 10MB).

micronaut.http.client.proxy-type

java.net.Proxy$Type

The proxy type

micronaut.http.client.proxy-address

java.net.SocketAddress

Sets a proxy address.

micronaut.http.client.proxy-username

java.lang.String

Sets the proxy user name to use.

micronaut.http.client.proxy-password

java.lang.String

Sets the proxy password.

🔗
Table 23. Configuration Properties for ServiceHttpClientConfiguration
Property Type Description

micronaut.http.services.*.urls

java.util.List

Sets the URIs of the service.

micronaut.http.services.*.health-check-uri

java.lang.String

Sets the health check URI. Default value ("/health").

micronaut.http.services.*.health-check

boolean

Sets whether the service health should be checked. Default value (false).

micronaut.http.services.*.health-check-interval

java.time.Duration

Sets the default duration to check health status. Default value (30 seconds).

micronaut.http.services.*.path

java.lang.String

Sets the context path to use for requests.

micronaut.http.services.*.ssl-configuration

SslConfiguration

Sets the SSL configuration for the client.

micronaut.http.services.*.logger-name

java.lang.String

Sets the client-specific logger name.

micronaut.http.services.*.follow-redirects

boolean

Sets whether redirects should be followed. Default value (DEFAULT_FOLLOW_REDIRECTS).

micronaut.http.services.*.default-charset

java.nio.charset.Charset

Sets the default charset to use. Default value (UTF-8);

micronaut.http.services.*.channel-options

java.util.Map

The Netty channel options

micronaut.http.services.*.shutdown-timeout

java.time.Duration

Sets the amount of time to wait for shutdown of client thread pools. Default value (100 milliseconds).

micronaut.http.services.*.read-timeout

java.time.Duration

Sets the read timeout. Default value (10 seconds).

micronaut.http.services.*.read-idle-timeout

java.time.Duration

Sets the max read idle time for streaming requests. Default value (5 seconds).

micronaut.http.services.*.connect-timeout

java.time.Duration

Sets the connect timeout.

micronaut.http.services.*.num-of-threads

java.lang.Integer

Sets the number of threads the client should use for requests.

micronaut.http.services.*.thread-factory

java.lang.Class

Sets a thread factory.

micronaut.http.services.*.max-content-length

int

Sets the maximum content length the client can consume. Default value (1024 * 1024 * 10 ⇒ 10MB).

micronaut.http.services.*.proxy-type

java.net.Proxy$Type

The proxy type

micronaut.http.services.*.proxy-address

java.net.SocketAddress

Sets a proxy address.

micronaut.http.services.*.proxy-username

java.lang.String

Sets the proxy user name to use.

micronaut.http.services.*.proxy-password

java.lang.String

Sets the proxy password.

micronaut.http.services.*.url

java.net.URI

Sets the URL of the service.

🔗
Table 24. Configuration Properties for ServiceHttpClientConfiguration$ServiceConnectionPoolConfiguration
Property Type Description

micronaut.http.services.*.pool.enabled

boolean

Sets whether connection pooling is enabled. Default value (false).

micronaut.http.services.*.pool.max-connections

int

Sets the maximum number of connections. Defaults to no maximum.

micronaut.http.services.*.pool.max-pending-acquires

int

Sets the max pending acquires.

micronaut.http.services.*.pool.acquire-timeout

java.time.Duration

Sets the timeout to wait for a connection.

Http Config Properties

🔗
Table 25. Configuration Properties for CodecConfiguration
Property Type Description

micronaut.codec.*.additional-types

java.util.List

Default value (Empty list).

🔗
Table 26. Configuration Properties for ServerSslConfiguration$DefaultKeyConfiguration
Property Type Description

micronaut.server.ssl.key

SslConfiguration$KeyConfiguration

Sets the key configuration.

micronaut.server.ssl.key.password

java.lang.String

Sets the password.

micronaut.server.ssl.key.alias

java.lang.String

Sets the alias.

🔗
Table 27. Configuration Properties for ClientSslConfiguration$DefaultTrustStoreConfiguration
Property Type Description

micronaut.http.client.ssl.trust-store

SslConfiguration$TrustStoreConfiguration

Sets the trust store configuration.

micronaut.http.client.ssl.trust-store.path

java.lang.String

Sets the path.

micronaut.http.client.ssl.trust-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.http.client.ssl.trust-store.type

java.lang.String

Sets the type of keystore.

micronaut.http.client.ssl.trust-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 28. Configuration Properties for ClientSslConfiguration$DefaultKeyStoreConfiguration
Property Type Description

micronaut.http.client.ssl.key-store

SslConfiguration$KeyStoreConfiguration

Sets the keystore configuration.

micronaut.http.client.ssl.key-store.path

java.lang.String

Sets the path.

micronaut.http.client.ssl.key-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.http.client.ssl.key-store.type

java.lang.String

Sets the type of keystore.

micronaut.http.client.ssl.key-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 29. Configuration Properties for DefaultSslConfiguration
Property Type Description

micronaut.ssl.enabled

boolean

Whether SSL is enabled. Default value (false).

micronaut.ssl.port

int

Sets the SSL port. Default value (8443).

micronaut.ssl.build-self-signed

boolean

Sets whether to build a self signed certificate. Default value (false).

micronaut.ssl.client-authentication

ClientAuthentication

Sets the client authentication mode.

micronaut.ssl.ciphers

java.lang.String[]

Sets the ciphers to use.

micronaut.ssl.protocols

java.lang.String[]

Sets the protocols to use.

micronaut.ssl.protocol

java.lang.String

Sets the protocol to use. Default value ("TLS").

🔗
Table 30. Configuration Properties for DefaultSslConfiguration$DefaultKeyStoreConfiguration
Property Type Description

micronaut.ssl.key-store

SslConfiguration$KeyStoreConfiguration

Sets the keystore configuration.

micronaut.ssl.key-store.path

java.lang.String

Sets the path.

micronaut.ssl.key-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.ssl.key-store.type

java.lang.String

Sets the type of keystore.

micronaut.ssl.key-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 31. Configuration Properties for DefaultSslConfiguration$DefaultKeyConfiguration
Property Type Description

micronaut.ssl.key

SslConfiguration$KeyConfiguration

Sets the key configuration.

micronaut.ssl.key.password

java.lang.String

Sets the password.

micronaut.ssl.key.alias

java.lang.String

Sets the alias.

🔗
Table 32. Configuration Properties for ServerSslConfiguration$DefaultKeyStoreConfiguration
Property Type Description

micronaut.server.ssl.key-store

SslConfiguration$KeyStoreConfiguration

Sets the keystore configuration.

micronaut.server.ssl.key-store.path

java.lang.String

Sets the path.

micronaut.server.ssl.key-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.server.ssl.key-store.type

java.lang.String

Sets the type of keystore.

micronaut.server.ssl.key-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 33. Configuration Properties for ClientSslConfiguration$DefaultKeyConfiguration
Property Type Description

micronaut.http.client.ssl.key

SslConfiguration$KeyConfiguration

Sets the key configuration.

micronaut.http.client.ssl.key.password

java.lang.String

Sets the password.

micronaut.http.client.ssl.key.alias

java.lang.String

Sets the alias.

🔗
Table 34. Configuration Properties for ServerSslConfiguration
Property Type Description

micronaut.server.ssl.enabled

boolean

Whether SSL is enabled. Default value (false).

micronaut.server.ssl.port

int

Sets the SSL port. Default value (8443).

micronaut.server.ssl.build-self-signed

boolean

Sets whether to build a self signed certificate. Default value (false).

micronaut.server.ssl.client-authentication

ClientAuthentication

Sets the client authentication mode.

micronaut.server.ssl.ciphers

java.lang.String[]

Sets the ciphers to use.

micronaut.server.ssl.protocols

java.lang.String[]

Sets the protocols to use.

micronaut.server.ssl.protocol

java.lang.String

Sets the protocol to use. Default value ("TLS").

🔗
Table 35. Configuration Properties for ClientSslConfiguration
Property Type Description

micronaut.http.client.ssl.enabled

boolean

Whether SSL is enabled. Default value (false).

micronaut.http.client.ssl.port

int

Sets the SSL port. Default value (8443).

micronaut.http.client.ssl.build-self-signed

boolean

Sets whether to build a self signed certificate. Default value (false).

micronaut.http.client.ssl.client-authentication

ClientAuthentication

Sets the client authentication mode.

micronaut.http.client.ssl.ciphers

java.lang.String[]

Sets the ciphers to use.

micronaut.http.client.ssl.protocols

java.lang.String[]

Sets the protocols to use.

micronaut.http.client.ssl.protocol

java.lang.String

Sets the protocol to use. Default value ("TLS").

🔗
Table 36. Configuration Properties for ServerSslConfiguration$DefaultTrustStoreConfiguration
Property Type Description

micronaut.server.ssl.trust-store

SslConfiguration$TrustStoreConfiguration

Sets the trust store configuration.

micronaut.server.ssl.trust-store.path

java.lang.String

Sets the path.

micronaut.server.ssl.trust-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.server.ssl.trust-store.type

java.lang.String

Sets the type of keystore.

micronaut.server.ssl.trust-store.provider

java.lang.String

Sets the keystore provider name.

🔗
Table 37. Configuration Properties for DefaultSslConfiguration$DefaultTrustStoreConfiguration
Property Type Description

micronaut.ssl.trust-store

SslConfiguration$TrustStoreConfiguration

Sets the trust store configuration.

micronaut.ssl.trust-store.path

java.lang.String

Sets the path.

micronaut.ssl.trust-store.password

java.lang.String

Sets the password to use for the keystore.

micronaut.ssl.trust-store.type

java.lang.String

Sets the type of keystore.

micronaut.ssl.trust-store.provider

java.lang.String

Sets the keystore provider name.

Http Server Config Properties

🔗
Table 38. Configuration Properties for HttpServerConfiguration$MultipartConfiguration
Property Type Description

micronaut.server.multipart.location

java.io.File

Sets the location to store files.

micronaut.server.multipart.max-file-size

long

Sets the max file size. Default value (1024 * 1024 ⇒ 1MB).

micronaut.server.multipart.enabled

boolean

Sets whether multipart processing is enabled. Default value (false).

micronaut.server.multipart.disk

boolean

Sets whether to buffer data to disk or not. Default value (false).

🔗
Table 39. Configuration Properties for HttpServerConfiguration
Property Type Description

micronaut.server.port

java.lang.Integer

Sets the port to bind to. Default value (-1)

micronaut.server.host

java.lang.String

Sets the host to bind to.

micronaut.server.read-timeout

java.lang.Integer

Sets the default read timeout.

micronaut.server.max-request-size

long

Sets the maximum request size. Default value (1024 * 1024 * 10 ⇒ // 10MB)

micronaut.server.read-idle-timeout

java.time.Duration

Sets the amount of time a connection can remain idle without any reads occurring. Default value (5 seconds).

micronaut.server.write-idle-timeout

java.time.Duration

Sets the amount of time a connection can remain idle without any writes occurring. Default value (5 seconds).

micronaut.server.idle-timeout

java.time.Duration

Sets the idle time of connections for the server. Default value (5 seconds).

micronaut.server.server-header

java.lang.String

Sets the name of the server header.

micronaut.server.date-header

boolean

Sets whether a date header should be sent back. Default value (true).

micronaut.server.log-handled-exceptions

boolean

Sets whether exceptions handled by either an error route or exception handler should still be logged. Default value (false).

micronaut.server.default-charset

java.nio.charset.Charset

The default charset to use

🔗
Table 40. Configuration Properties for HttpServerConfiguration$CorsConfiguration
Property Type Description

micronaut.server.cors.enabled

boolean

Sets whether CORS is enabled. Default value (false)

micronaut.server.cors.configurations

java.util.Map

Sets the CORS configurations.

Http Server Netty Config Properties

🔗
Table 41. Configuration Properties for FileTypeHandlerConfiguration
Property Type Description

netty.responses.file.cache-seconds

int

Cache Seconds. Default value (60).

🔗
Table 42. Configuration Properties for NettyHttpServerConfiguration
Property Type Description

micronaut.server.netty.child-options

java.util.Map

Sets the Netty child worker options.

micronaut.server.netty.options

java.util.Map

Sets the channel options.

micronaut.server.netty.max-initial-line-length

int

Sets the maximum initial line length for the HTTP request. Default value (4096).

micronaut.server.netty.max-header-size

int

Sets the maximum size of any one header. Default value (8192).

micronaut.server.netty.max-chunk-size

int

Sets the maximum size of any single request chunk. Default value (8192).

micronaut.server.netty.chunked-supported

boolean

Sets whether chunked transfer encoding is supported. Default value (true).

micronaut.server.netty.validate-headers

boolean

Sets whether to validate incoming headers. Default value (true).

micronaut.server.netty.initial-buffer-size

int

Sets the initial buffer size. Default value (128).

micronaut.server.netty.log-level

io.netty.handler.logging.LogLevel

Sets the Netty log level.

🔗
Table 43. Configuration Properties for NettyHttpServerConfiguration$Worker
Property Type Description

micronaut.server.netty.worker.threads

int

Sets the number of threads for the event loop group.

micronaut.server.netty.worker.io-ratio

java.lang.Integer

Sets the I/O ratio.

micronaut.server.netty.worker.executor

java.lang.String

Sets the name of the executor.

🔗
Table 44. Configuration Properties for NettyHttpServerConfiguration$Parent
Property Type Description

micronaut.server.netty.parent.threads

int

Sets the number of threads for the event loop group.

micronaut.server.netty.parent.io-ratio

java.lang.Integer

Sets the I/O ratio.

micronaut.server.netty.parent.executor

java.lang.String

Sets the name of the executor.

Jdbc Dbcp Config Properties

🔗
Table 45. Configuration Properties for DatasourceConfiguration
Property Type Description

datasources.*.default-auto-commit

java.lang.Boolean

datasources.*.default-read-only

java.lang.Boolean

datasources.*.default-transaction-isolation

int

datasources.*.default-query-timeout

java.lang.Integer

datasources.*.default-catalog

java.lang.String

datasources.*.cache-state

boolean

datasources.*.driver

java.sql.Driver

datasources.*.driver-class-name

java.lang.String

datasources.*.driver-class-loader

java.lang.ClassLoader

datasources.*.lifo

boolean

datasources.*.max-total

int

datasources.*.max-idle

int

datasources.*.min-idle

int

datasources.*.initial-size

int

datasources.*.max-wait-millis

long

datasources.*.pool-prepared-statements

boolean

datasources.*.max-open-prepared-statements

int

datasources.*.test-on-create

boolean

datasources.*.test-on-borrow

boolean

datasources.*.test-on-return

boolean

datasources.*.time-between-eviction-runs-millis

long

datasources.*.num-tests-per-eviction-run

int

datasources.*.min-evictable-idle-time-millis

long

datasources.*.soft-min-evictable-idle-time-millis

long

datasources.*.eviction-policy-class-name

java.lang.String

datasources.*.test-while-idle

boolean

datasources.*.password

java.lang.String

datasources.*.url

java.lang.String

datasources.*.username

java.lang.String

datasources.*.validation-query

java.lang.String

datasources.*.validation-query-timeout

int

datasources.*.connection-init-sqls

java.util.Collection

datasources.*.access-to-underlying-connection-allowed

boolean

datasources.*.max-conn-lifetime-millis

long

datasources.*.log-expired-connections

boolean

datasources.*.jmx-name

java.lang.String

datasources.*.enable-auto-commit-on-return

boolean

datasources.*.rollback-on-return

boolean

datasources.*.disconnection-sql-codes

java.util.Collection

datasources.*.fast-fail-validation

boolean

datasources.*.login-timeout

int

datasources.*.log-writer

java.io.PrintWriter

datasources.*.remove-abandoned-on-maintenance

boolean

datasources.*.remove-abandoned-on-borrow

boolean

datasources.*.remove-abandoned-timeout

int

datasources.*.log-abandoned

boolean

datasources.*.abandoned-log-writer

java.io.PrintWriter

datasources.*.abandoned-usage-tracking

boolean

datasources.*.connection-properties

java.lang.String

Jdbc Hikari Config Properties

🔗
Table 46. Configuration Properties for DatasourceConfiguration
Property Type Description

datasources.*.connection-timeout

long

datasources.*.idle-timeout

long

datasources.*.leak-detection-threshold

long

datasources.*.max-lifetime

long

datasources.*.maximum-pool-size

int

datasources.*.minimum-idle

int

datasources.*.password

java.lang.String

datasources.*.username

java.lang.String

datasources.*.validation-timeout

long

datasources.*.catalog

java.lang.String

datasources.*.connection-test-query

java.lang.String

datasources.*.connection-init-sql

java.lang.String

datasources.*.data-source

javax.sql.DataSource

datasources.*.data-source-class-name

java.lang.String

datasources.*.data-source-jndi

java.lang.String

datasources.*.data-source-properties

java.util.Properties

datasources.*.driver-class-name

java.lang.String

datasources.*.jdbc-url

java.lang.String

datasources.*.auto-commit

boolean

datasources.*.allow-pool-suspension

boolean

datasources.*.initialization-fail-timeout

long

datasources.*.initialization-fail-fast

boolean

datasources.*.isolate-internal-queries

boolean

datasources.*.jdbc4connection-test

boolean

datasources.*.metrics-tracker-factory

com.zaxxer.hikari.metrics.MetricsTrackerFactory

datasources.*.metric-registry

java.lang.Object

datasources.*.health-check-registry

java.lang.Object

datasources.*.health-check-properties

java.util.Properties

datasources.*.read-only

boolean

datasources.*.register-mbeans

boolean

datasources.*.pool-name

java.lang.String

datasources.*.scheduled-executor-service

java.util.concurrent.ScheduledThreadPoolExecutor

datasources.*.scheduled-executor

java.util.concurrent.ScheduledExecutorService

datasources.*.schema

java.lang.String

datasources.*.transaction-isolation

java.lang.String

datasources.*.thread-factory

java.util.concurrent.ThreadFactory

datasources.*.url

java.lang.String

Setter.

datasources.*.validation-query

java.lang.String

Setter.

datasources.*.jndi-name

java.lang.String

Setter.

Jdbc Tomcat Config Properties

🔗
Table 47. Configuration Properties for DatasourceConfiguration
Property Type Description

datasources.*.abandon-when-percentage-full

int

datasources.*.fair-queue

boolean

datasources.*.validation-query-timeout

int

datasources.*.validator

org.apache.tomcat.jdbc.pool.Validator

datasources.*.access-to-underlying-connection-allowed

boolean

datasources.*.connection-properties

java.lang.String

datasources.*.default-auto-commit

java.lang.Boolean

datasources.*.default-catalog

java.lang.String

datasources.*.default-read-only

java.lang.Boolean

datasources.*.default-transaction-isolation

int

datasources.*.driver-class-name

java.lang.String

datasources.*.initial-size

int

datasources.*.log-abandoned

boolean

datasources.*.max-active

int

datasources.*.max-idle

int

datasources.*.max-wait

int

datasources.*.min-evictable-idle-time-millis

int

datasources.*.min-idle

int

datasources.*.name

java.lang.String

datasources.*.num-tests-per-eviction-run

int

datasources.*.password

java.lang.String

datasources.*.remove-abandoned

boolean

datasources.*.remove-abandoned-timeout

int

datasources.*.test-on-borrow

boolean

datasources.*.test-while-idle

boolean

datasources.*.test-on-return

boolean

datasources.*.time-between-eviction-runs-millis

int

datasources.*.url

java.lang.String

datasources.*.username

java.lang.String

datasources.*.validation-interval

long

datasources.*.validation-query

java.lang.String

datasources.*.validator-class-name

java.lang.String

datasources.*.init-sql

java.lang.String

datasources.*.test-on-connect

boolean

datasources.*.jdbc-interceptors

java.lang.String

datasources.*.jmx-enabled

boolean

datasources.*.suspect-timeout

int

datasources.*.use-equals

boolean

datasources.*.max-age

long

datasources.*.use-lock

boolean

datasources.*.data-source

java.lang.Object

datasources.*.data-source-jndi

java.lang.String

datasources.*.alternate-username-allowed

boolean

datasources.*.commit-on-return

boolean

datasources.*.rollback-on-return

boolean

datasources.*.use-disposable-connection-facade

boolean

datasources.*.log-validation-errors

boolean

datasources.*.propagate-interrupt-state

boolean

datasources.*.ignore-exception-on-pre-load

boolean

datasources.*.use-statement-facade

boolean

datasources.*.db-properties

java.util.Properties

datasources.*.jndi-name

java.lang.String

Set the JDNI name

Jmx Config Properties

🔗
Table 48. Configuration Properties for JmxConfiguration
Property Type Description

jmx.agent-id

java.lang.String

Sets the agent id.

jmx.domain

java.lang.String

Sets the domain to create a new server with.

jmx.add-to-factory

boolean

Sets if the server should be kept in the factory. Default true.

jmx.ignore-agent-not-found

boolean

Sets to ignore the exception if the agent is not found. Default false.

jmx.register-endpoints

boolean

Sets if endpoints should be registered. Default true.

Kafka Config Properties

🔗
Table 49. Configuration Properties for KafkaEmbeddedConfiguration
Property Type Description

kafka.embedded.enabled

boolean

Sets whether the embedded Kafka server is enabled. Default value (false).

kafka.embedded.topics

java.util.List

The topics that should be created by the embedded instance.

kafka.embedded.properties

java.util.Properties

Sets the broker properties.

🔗
Table 50. Configuration Properties for KafkaProducerConfiguration
Property Type Description

kafka.producers.*.key-serializer

org.apache.kafka.common.serialization.Serializer

Sets the key serializer.

kafka.producers.*.value-serializer

org.apache.kafka.common.serialization.Serializer

Sets the default value serializer.

🔗
Table 51. Configuration Properties for KafkaDefaultConfiguration
Property Type Description

kafka.health-timeout

java.time.Duration

The health check timeout. Default value (1 seconds).

🔗
Table 52. Configuration Properties for KafkaConsumerConfiguration
Property Type Description

kafka.consumers.*.key-deserializer

org.apache.kafka.common.serialization.Deserializer

Sets the key deserializer.

kafka.consumers.*.value-deserializer

org.apache.kafka.common.serialization.Deserializer

Sets the default value deserializer.

Management Config Properties

🔗
Table 53. Configuration Properties for EndpointConfiguration
Property Type Description

endpoints.*.enabled

java.lang.Boolean

Sets whether the endpoint is enabled.

endpoints.*.sensitive

java.lang.Boolean

Sets whether the endpoint is sensitive.

🔗
Table 54. Configuration Properties for HealthEndpoint
Property Type Description

endpoints.health.details-visible

DetailsVisibility

Sets the visibility policy for health information.

🔗
Table 55. Configuration Properties for EndpointDefaultConfiguration
Property Type Description

endpoints.all.enabled

java.lang.Boolean

Sets whether the endpoint is enabled.

endpoints.all.sensitive

java.lang.Boolean

Sets whether the endpoint is sensitive.

endpoints.all.path

java.lang.String

The endpoints base path. Default value ("/").

🔗
Table 56. Configuration Properties for HealthEndpoint$StatusConfiguration
Property Type Description

endpoints.health.status.http-mapping

java.util.Map

Set how HealthStatus map to HttpStatus codes.

🔗
Table 57. Configuration Properties for DiskSpaceIndicatorConfiguration
Property Type Description

endpoints.health.disk-space.enabled

boolean

Default value (true).

endpoints.health.disk-space.path

java.io.File

Default value (".").

endpoints.health.disk-space.threshold

long

Default value (1024 * 1024 * 10 ⇒ 10MB).

Mongo Reactive Config Properties

🔗
Table 58. Configuration Properties for DefaultMongoConfiguration
Property Type Description

mongodb.uri

java.lang.String

Sets the MongoDB URI.

mongodb.host

com.mongodb.ServerAddress

Sets the server MongoDB server address.

mongodb.hosts

java.util.List

Sets the server MongoDB server address.

🔗
Table 59. Configuration Properties for NamedReactiveMongoConfiguration
Property Type Description

mongodb.servers.*.apply-connection-string

com.mongodb.ConnectionString

mongodb.servers.*.apply-to-cluster-settings

com.mongodb.Block

mongodb.servers.*.apply-to-socket-settings

com.mongodb.Block

mongodb.servers.*.apply-to-connection-pool-settings

com.mongodb.Block

mongodb.servers.*.apply-to-server-settings

com.mongodb.Block

mongodb.servers.*.apply-to-ssl-settings

com.mongodb.Block

mongodb.servers.*.read-preference

com.mongodb.ReadPreference

mongodb.servers.*.write-concern

com.mongodb.WriteConcern

mongodb.servers.*.retry-writes

boolean

mongodb.servers.*.read-concern

com.mongodb.ReadConcern

mongodb.servers.*.credential

com.mongodb.MongoCredential

mongodb.servers.*.codec-registry

org.bson.codecs.configuration.CodecRegistry

mongodb.servers.*.stream-factory-factory

com.mongodb.connection.StreamFactoryFactory

mongodb.servers.*.add-command-listener

com.mongodb.event.CommandListener

mongodb.servers.*.command-listener-list

java.util.List

mongodb.servers.*.application-name

java.lang.String

mongodb.servers.*.compressor-list

java.util.List

mongodb.servers.*.cluster.apply-settings

com.mongodb.connection.ClusterSettings

mongodb.servers.*.cluster.description

java.lang.String

mongodb.servers.*.cluster.hosts

java.util.List

mongodb.servers.*.cluster.mode

com.mongodb.connection.ClusterConnectionMode

mongodb.servers.*.cluster.required-replica-set-name

java.lang.String

mongodb.servers.*.cluster.required-cluster-type

com.mongodb.connection.ClusterType

mongodb.servers.*.cluster.local-threshold

java.time.Duration

mongodb.servers.*.cluster.server-selector

com.mongodb.selector.ServerSelector

mongodb.servers.*.cluster.server-selection-timeout

java.time.Duration

mongodb.servers.*.cluster.max-wait-queue-size

int

mongodb.servers.*.cluster.add-cluster-listener

com.mongodb.event.ClusterListener

mongodb.servers.*.cluster.apply-connection-string

com.mongodb.ConnectionString

mongodb.servers.*.server.apply-settings

com.mongodb.connection.ServerSettings

mongodb.servers.*.server.heartbeat-frequency

java.time.Duration

mongodb.servers.*.server.min-heartbeat-frequency

java.time.Duration

mongodb.servers.*.server.add-server-listener

com.mongodb.event.ServerListener

mongodb.servers.*.server.add-server-monitor-listener

com.mongodb.event.ServerMonitorListener

mongodb.servers.*.server.apply-connection-string

com.mongodb.ConnectionString

mongodb.servers.*.connection-pool.apply-settings

com.mongodb.connection.ConnectionPoolSettings

mongodb.servers.*.connection-pool.max-size

int

mongodb.servers.*.connection-pool.min-size

int

mongodb.servers.*.connection-pool.max-wait-queue-size

int

mongodb.servers.*.connection-pool.max-wait-time

java.time.Duration

mongodb.servers.*.connection-pool.max-connection-life-time

java.time.Duration

mongodb.servers.*.connection-pool.max-connection-idle-time

java.time.Duration

mongodb.servers.*.connection-pool.maintenance-initial-delay

java.time.Duration

mongodb.servers.*.connection-pool.maintenance-frequency

java.time.Duration

mongodb.servers.*.connection-pool.add-connection-pool-listener

com.mongodb.event.ConnectionPoolListener

mongodb.servers.*.connection-pool.apply-connection-string

com.mongodb.ConnectionString

mongodb.servers.*.socket.apply-settings

com.mongodb.connection.SocketSettings

mongodb.servers.*.socket.receive-buffer-size

int

mongodb.servers.*.socket.send-buffer-size

int

mongodb.servers.*.socket.apply-connection-string

com.mongodb.ConnectionString

mongodb.servers.*.ssl.apply-settings

com.mongodb.connection.SslSettings

mongodb.servers.*.ssl.enabled

boolean

mongodb.servers.*.ssl.invalid-host-name-allowed

boolean

mongodb.servers.*.ssl.context

javax.net.ssl.SSLContext

mongodb.servers.*.ssl.apply-connection-string

com.mongodb.ConnectionString

mongodb.servers.*.options.description

java.lang.String

mongodb.servers.*.options.application-name

java.lang.String

mongodb.servers.*.options.compressor-list

java.util.List

mongodb.servers.*.options.min-connections-per-host

int

mongodb.servers.*.options.connections-per-host

int

mongodb.servers.*.options.threads-allowed-to-block-for-connection-multiplier

int

mongodb.servers.*.options.server-selection-timeout

int

mongodb.servers.*.options.max-wait-time

int

mongodb.servers.*.options.max-connection-idle-time

int

mongodb.servers.*.options.max-connection-life-time

int

mongodb.servers.*.options.connect-timeout

int

mongodb.servers.*.options.socket-timeout

int

mongodb.servers.*.options.ssl-enabled

boolean

mongodb.servers.*.options.ssl-invalid-host-name-allowed

boolean

mongodb.servers.*.options.ssl-context

javax.net.ssl.SSLContext

mongodb.servers.*.options.read-preference

com.mongodb.ReadPreference

mongodb.servers.*.options.write-concern

com.mongodb.WriteConcern

mongodb.servers.*.options.retry-writes

boolean

mongodb.servers.*.options.read-concern

com.mongodb.ReadConcern

mongodb.servers.*.options.codec-registry

org.bson.codecs.configuration.CodecRegistry

mongodb.servers.*.options.server-selector

com.mongodb.selector.ServerSelector

mongodb.servers.*.options.add-command-listener

com.mongodb.event.CommandListener

mongodb.servers.*.options.add-connection-pool-listener

com.mongodb.event.ConnectionPoolListener

mongodb.servers.*.options.add-cluster-listener

com.mongodb.event.ClusterListener

mongodb.servers.*.options.add-server-listener

com.mongodb.event.ServerListener

mongodb.servers.*.options.add-server-monitor-listener

com.mongodb.event.ServerMonitorListener

mongodb.servers.*.options.socket-factory

javax.net.SocketFactory

mongodb.servers.*.options.cursor-finalizer-enabled

boolean

mongodb.servers.*.options.always-use-mbeans

boolean

mongodb.servers.*.options.db-decoder-factory

com.mongodb.DBDecoderFactory

mongodb.servers.*.options.db-encoder-factory

com.mongodb.DBEncoderFactory

mongodb.servers.*.options.heartbeat-frequency

int

mongodb.servers.*.options.min-heartbeat-frequency

int

mongodb.servers.*.options.heartbeat-connect-timeout

int

mongodb.servers.*.options.heartbeat-socket-timeout

int

mongodb.servers.*.options.local-threshold

int

mongodb.servers.*.options.required-replica-set-name

java.lang.String

mongodb.servers.*.uri

java.lang.String

Sets the MongoDB URI.

Multitenancy Config Properties

🔗
Table 60. Configuration Properties for PrincipalTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.principal.enabled

boolean

Enables PrincipalTenantResolver. The default enable is false.

🔗
Table 61. Configuration Properties for FixedTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.fixed.enabled

boolean

Enables FixedTenantResolver. Default value (false).

micronaut.multitenancy.tenantresolver.fixed.tenant-id

java.lang.String

The fixed tenant ID. Default value to ("DEFAULT").

🔗
Table 62. Configuration Properties for CookieTenantWriterConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantwriter.cookie.cookiename

java.lang.String

Cookie Name. Default value ("tenantId").

micronaut.multitenancy.tenantwriter.cookie.enabled

boolean

Enables CookieTenantWriter. Default value (false).

🔗
Table 63. Configuration Properties for SessionTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.session.attribute

java.lang.String

Session Attribute name. Default value ("tenantId")

micronaut.multitenancy.tenantresolver.session.enabled

boolean

Enables SessionTenantResolver. The default value (false).

🔗
Table 64. Configuration Properties for TenantPropagationConfigurationProperties
Property Type Description

micronaut.multitenancy.propagation.enabled

boolean

Whether TenantPropagationHttpClientFilter should be enabled. Default value (false).

micronaut.multitenancy.propagation.service-id-regex

java.lang.String

Regular expression to match service ID.

micronaut.multitenancy.propagation.uri-regex

java.lang.String

Regular expression to match URI.

micronaut.multitenancy.propagation.path

java.lang.String

Configures TenantPropagationHttpClientFilter path. Default value "/**"

🔗
Table 65. Configuration Properties for SubdomainTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.subdomain.enabled

boolean

Enables SubdomainTenantResolver. Default value (false).

🔗
Table 66. Configuration Properties for HttpHeaderTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.httpheader.header-name

java.lang.String

Http Header name which should be used to resolve the tenant id from. Default value ("tenantId").

micronaut.multitenancy.tenantresolver.httpheader.enabled

boolean

Enables HttpHeaderTenantResolver. Default value (false).

🔗
Table 67. Configuration Properties for CookieTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.cookie.cookiename

java.lang.String

Cookie name which should be used to resolve the tenant id from. Default value ("tenantId").

micronaut.multitenancy.tenantresolver.cookie.enabled

boolean

Whether to enable CookieTenantResolver. Default value (false).

🔗
Table 68. Configuration Properties for HttpHeaderTenantWriterConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantwriter.httpheader.header-name

java.lang.String

Http Header name. Default value ("tenantId").

micronaut.multitenancy.tenantwriter.httpheader.enabled

boolean

Enables HttpHeaderTenantWriter. Default value (false).

🔗
Table 69. Configuration Properties for SystemPropertyTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.systemproperty.enabled

boolean

Enable SystemPropertyTenantResolver. Default value (false).

micronaut.multitenancy.tenantresolver.systemproperty.property-name

java.lang.String

System property name. Default value ("tenantId").

Neo4j Bolt Config Properties

🔗
Table 70. Configuration Properties for Neo4jBoltConfiguration
Property Type Description

neo4j.uris

java.util.List

Set a {@link List} of Neo4J {@link URI}.

neo4j.username

java.lang.String

The username

neo4j.password

java.lang.String

The password

neo4j.retry-count

int

Default value (3).

neo4j.retry-delay

java.time.Duration

Default value (1).

neo4j.uri

java.net.URI

Set a single {@link URI}.

🔗
Table 71. Configuration Properties for Neo4jBoltConfiguration$Neo4jEmbeddedSettings
Property Type Description

neo4j.embedded.logging

org.neo4j.driver.v1.Logging

neo4j.embedded.load-balancing-strategy

org.neo4j.driver.v1.Config$LoadBalancingStrategy

neo4j.embedded.leaked-sessions-logging

java.lang.Boolean

neo4j.embedded.connection-liveness-check-timeout

java.time.Duration

neo4j.embedded.max-connection-lifetime

java.time.Duration

neo4j.embedded.max-connection-pool-size

int

neo4j.embedded.connection-acquisition-timeout

java.time.Duration

neo4j.embedded.encryption

java.lang.Boolean

neo4j.embedded.out-encryption

java.lang.Boolean

neo4j.embedded.trust-strategy

org.neo4j.driver.v1.Config$TrustStrategy

neo4j.embedded.connection-timeout

java.time.Duration

neo4j.embedded.max-transaction-retry-time

java.time.Duration

neo4j.embedded.options

java.util.Map

The options to pass to the embedded server

neo4j.embedded.directory

java.lang.String

The directory

neo4j.embedded.drop-data

boolean

Default value (false).

neo4j.embedded.ephemeral

boolean

Default value (false).

neo4j.embedded.enabled

boolean

Default value (true).

Netflix Ribbon Config Properties

🔗
Table 72. Configuration Properties for DefaultRibbonClientConfig
Property Type Description

ribbon.vip-address-resolver

com.netflix.client.VipAddressResolver

Sets an optional {@link com.netflix.client.VipAddressResolver}.

🔗
Table 73. Configuration Properties for NamedRibbonClientConfig
Property Type Description

ribbon.clients.*.vip-address-resolver

com.netflix.client.VipAddressResolver

Sets an optional {@link com.netflix.client.VipAddressResolver}.

Postgres Reactive Config Properties

🔗
Table 74. Configuration Properties for PgPoolConfiguration
Property Type Description

postgres.reactive.client.max-size

int

postgres.reactive.client.max-wait-queue-size

int

postgres.reactive.client.host

java.lang.String

postgres.reactive.client.port

int

postgres.reactive.client.database

java.lang.String

postgres.reactive.client.user

java.lang.String

postgres.reactive.client.password

java.lang.String

postgres.reactive.client.pipelining-limit

int

postgres.reactive.client.cache-prepared-statements

boolean

postgres.reactive.client.send-buffer-size

int

postgres.reactive.client.receive-buffer-size

int

postgres.reactive.client.reuse-address

boolean

postgres.reactive.client.traffic-class

int

postgres.reactive.client.tcp-no-delay

boolean

postgres.reactive.client.tcp-keep-alive

boolean

postgres.reactive.client.so-linger

int

postgres.reactive.client.use-pooled-buffers

boolean

postgres.reactive.client.idle-timeout

int

postgres.reactive.client.ssl

boolean

postgres.reactive.client.key-cert-options

io.vertx.core.net.KeyCertOptions

postgres.reactive.client.key-store-options

io.vertx.core.net.JksOptions

postgres.reactive.client.pfx-key-cert-options

io.vertx.core.net.PfxOptions

postgres.reactive.client.pem-key-cert-options

io.vertx.core.net.PemKeyCertOptions

postgres.reactive.client.trust-options

io.vertx.core.net.TrustOptions

postgres.reactive.client.trust-store-options

io.vertx.core.net.JksOptions

postgres.reactive.client.pem-trust-options

io.vertx.core.net.PemTrustOptions

postgres.reactive.client.pfx-trust-options

io.vertx.core.net.PfxOptions

postgres.reactive.client.trust-all

boolean

postgres.reactive.client.connect-timeout

int

postgres.reactive.client.metrics-name

java.lang.String

postgres.reactive.client.reconnect-attempts

int

postgres.reactive.client.hostname-verification-algorithm

java.lang.String

postgres.reactive.client.log-activity

boolean

postgres.reactive.client.reconnect-interval

long

postgres.reactive.client.proxy-options

io.vertx.core.net.ProxyOptions

postgres.reactive.client.local-address

java.lang.String

postgres.reactive.client.use-alpn

boolean

postgres.reactive.client.ssl-engine-options

io.vertx.core.net.SSLEngineOptions

postgres.reactive.client.jdk-ssl-engine-options

io.vertx.core.net.JdkSSLEngineOptions

postgres.reactive.client.open-ssl-engine-options

io.vertx.core.net.OpenSSLEngineOptions

postgres.reactive.client.reuse-port

boolean

postgres.reactive.client.tcp-fast-open

boolean

postgres.reactive.client.tcp-cork

boolean

postgres.reactive.client.tcp-quick-ack

boolean

postgres.reactive.client.enabled-secure-transport-protocols

java.util.Set

postgres.reactive.client.uri

java.lang.String

Rabbitmq Config Properties

🔗
Table 75. Configuration Properties for RabbitConnectionFactoryConfig
Property Type Description

rabbitmq.host

java.lang.String

rabbitmq.port

int

rabbitmq.username

java.lang.String

rabbitmq.password

java.lang.String

rabbitmq.credentials-provider

com.rabbitmq.client.impl.CredentialsProvider

rabbitmq.virtual-host

java.lang.String

rabbitmq.uri

java.net.URI

rabbitmq.requested-channel-max

int

rabbitmq.requested-frame-max

int

rabbitmq.connection-timeout

int

rabbitmq.handshake-timeout

int

rabbitmq.shutdown-timeout

int

rabbitmq.requested-heartbeat

int

rabbitmq.client-properties

java.util.Map

rabbitmq.sasl-config

com.rabbitmq.client.SaslConfig

rabbitmq.socket-factory

javax.net.SocketFactory

rabbitmq.socket-configurator

com.rabbitmq.client.SocketConfigurator

rabbitmq.shared-executor

java.util.concurrent.ExecutorService

rabbitmq.shutdown-executor

java.util.concurrent.ExecutorService

rabbitmq.heartbeat-executor

java.util.concurrent.ScheduledExecutorService

rabbitmq.thread-factory

java.util.concurrent.ThreadFactory

rabbitmq.exception-handler

com.rabbitmq.client.ExceptionHandler

rabbitmq.automatic-recovery-enabled

boolean

rabbitmq.topology-recovery-enabled

boolean

rabbitmq.metrics-collector

com.rabbitmq.client.MetricsCollector

rabbitmq.network-recovery-interval

int

rabbitmq.recovery-delay-handler

com.rabbitmq.client.RecoveryDelayHandler

rabbitmq.nio-params

com.rabbitmq.client.impl.nio.NioParams

rabbitmq.channel-rpc-timeout

int

rabbitmq.ssl-context-factory

com.rabbitmq.client.SslContextFactory

rabbitmq.channel-should-check-rpc-response-type

boolean

rabbitmq.work-pool-timeout

int

rabbitmq.error-on-write-listener

com.rabbitmq.client.impl.ErrorOnWriteListener

Redis Lettuce Config Properties

🔗
Table 76. Configuration Properties for NamedRedisServersConfiguration
Property Type Description

redis.servers.*.host

java.lang.String

redis.servers.*.sentinel-master-id

java.lang.String

redis.servers.*.port

int

redis.servers.*.socket

java.lang.String

redis.servers.*.password

java.lang.String

redis.servers.*.timeout

java.time.Duration

redis.servers.*.database

int

redis.servers.*.client-name

java.lang.String

redis.servers.*.ssl

boolean

redis.servers.*.verify-peer

boolean

redis.servers.*.start-tls

boolean

redis.servers.*.uri

java.net.URI

Sets the Redis URI for configuration by string.

redis.servers.*.uris

java.net.URI[]

Sets the Redis URIs for cluster configuration.

🔗
Table 77. Configuration Properties for DefaultRedisConfiguration
Property Type Description

redis.host

java.lang.String

redis.sentinel-master-id

java.lang.String

redis.port

int

redis.socket

java.lang.String

redis.password

java.lang.String

redis.timeout

java.time.Duration

redis.database

int

redis.client-name

java.lang.String

redis.ssl

boolean

redis.verify-peer

boolean

redis.start-tls

boolean

redis.uri

java.net.URI

Sets the Redis URI for configuration by string.

redis.uris

java.net.URI[]

Sets the Redis URIs for cluster configuration.

🔗
Table 78. Configuration Properties for RedisHttpSessionConfiguration
Property Type Description

micronaut.session.http.redis.namespace

java.lang.String

Sets the namespace to use.

micronaut.session.http.redis.server-name

java.lang.String

Sets the server name.

micronaut.session.http.redis.session-created-topic

java.lang.String

Sets the topic to publish session created events to.

micronaut.session.http.redis.active-sessions-key

java.lang.String

Sets the key to store active sessions in.

micronaut.session.http.redis.value-serializer

java.lang.Class

Sets the default value serializer to use.

micronaut.session.http.redis.charset

java.nio.charset.Charset

Sets the charset to use to serialize values.

micronaut.session.http.redis.enable-keyspace-events

boolean

Sets whether keyspace events should be enabled at startup.

micronaut.session.http.redis.write-mode

RedisHttpSessionConfiguration$WriteMode

Sets the write mode to use.

micronaut.session.http.redis.expired-session-check

java.time.Duration

Sets the duration to check for expired sessions.

🔗
Table 79. Configuration Properties for RedisCacheConfiguration
Property Type Description

micronaut.caches.*.redis.caches.*.redis-exec-provider

redis.embedded.RedisExecProvider

micronaut.caches.*.redis.caches.*.port

java.lang.Integer

micronaut.caches.*.redis.caches.*.slave-of

java.net.InetSocketAddress

micronaut.caches.*.redis.caches.*.config-file

java.lang.String

micronaut.caches.*.redis.caches.*.setting

java.lang.String

micronaut.caches.*.redis.caches.*.server

java.lang.String

micronaut.caches.*.redis.caches.*.key-serializer

java.lang.Class

micronaut.caches.*.redis.caches.*.value-serializer

java.lang.Class

Router Config Properties

🔗
Table 80. Configuration Properties for StaticResourceConfiguration
Property Type Description

micronaut.router.static-resources.*.enabled

boolean

Sets whether this specific mapping is enabled. Default value (true).

micronaut.router.static-resources.*.paths

java.util.List

A list of paths either starting with classpath: or file:. You can serve files from anywhere on disk or the classpath. For example to serve static resources from src/main/resources/public, you would use classpath:public as the path.

micronaut.router.static-resources.*.mapping

java.lang.String

The path resources should be served from. Uses ant path matching. Default value ("/**").

Runtime Config Properties

🔗
Table 81. Configuration Properties for ApplicationConfiguration$InstanceConfiguration
Property Type Description

micronaut.application.instance.id

java.lang.String

The instance identifier

micronaut.application.instance.group

java.lang.String

The instance auto scaling group

micronaut.application.instance.zone

java.lang.String

The instance availability zone

micronaut.application.instance.metadata

java.util.Map

The metadata to associate with the instance

🔗
Table 82. Configuration Properties for UserExecutorConfiguration
Property Type Description

micronaut.executors.*.n-threads

java.lang.Integer

micronaut.executors.*.type

ExecutorType

Sets the executor type. Default value (SCHEDULED).

micronaut.executors.*.parallelism

java.lang.Integer

Sets the parallelism for WORK_STEALING. Default value (Number of processors available to the Java virtual machine).

micronaut.executors.*.core-pool-size

java.lang.Integer

Sets the core pool size for SCHEDULED. Default value (2 * Number of processors available to the Java virtual machine).

micronaut.executors.*.thread-factory-class

java.lang.Class

Sets the thread factory class.

micronaut.executors.*.number-of-threads

java.lang.Integer

Sets the number of threads for FIXED. Default value (2 * Number of processors available to the Java virtual machine).

🔗
Table 83. Configuration Properties for ApplicationConfiguration
Property Type Description

micronaut.application.default-charset

java.nio.charset.Charset

Default value (UTF-8).

micronaut.application.name

java.lang.String

Set the application name

🔗
Table 84. Configuration Properties for HeartbeatConfiguration
Property Type Description

micronaut.heartbeat.interval

java.time.Duration

Default value (15 seconds).

micronaut.heartbeat.enabled

boolean

Default value (true).

🔗
Table 85. Configuration Properties for CacheConfiguration
Property Type Description

micronaut.caches.*.charset

java.nio.charset.Charset

The charset used to serialize and deserialize values

micronaut.caches.*.initial-capacity

java.lang.Integer

The initial cache capacity.

micronaut.caches.*.maximum-size

java.lang.Long

Specifies the maximum number of entries the cache may contain

micronaut.caches.*.maximum-weight

java.lang.Long

Specifies the maximum weight of entries

micronaut.caches.*.expire-after-write

java.time.Duration

The cache expiration duration after writing into it.

micronaut.caches.*.expire-after-access

java.time.Duration

The cache expiration duration after accessing it

micronaut.caches.*.test-mode

boolean

Set whether test mode is enabled. Default value (false).

🔗
Table 86. Configuration Properties for AmazonMetadataConfiguration
Property Type Description

micronaut.application.ec2.metadata.url

java.lang.String

Default value ("http://169.254.169.254/").

micronaut.application.ec2.metadata.metadata-url

java.lang.String

The metadata Url

micronaut.application.ec2.metadata.instance-document-url

java.lang.String

The instance document Url

micronaut.application.ec2.metadata.enabled

boolean

Default value (true).

🔗
Table 87. Configuration Properties for JacksonConfiguration
Property Type Description

jackson.date-format

java.lang.String

Sets the default date format to use.

jackson.locale

java.util.Locale

Sets the locale to use.

jackson.time-zone

java.util.TimeZone

Sets the timezone to use.

jackson.array-size-threshold

int

Sets the array size threshold for data binding. Default value (100).

jackson.serialization

java.util.Map

Sets the serialization features to use.

jackson.deserialization

java.util.Map

Sets the deserialization features to use.

jackson.mapper

java.util.Map

Sets the object mapper features to use.

jackson.parser

java.util.Map

Sets the parser features to use.

jackson.generator

java.util.Map

Sets the generator features to use.

jackson.serialization-inclusion

com.fasterxml.jackson.annotation.JsonInclude$Include

Sets the serialization inclusion mode.

🔗
Table 88. Configuration Properties for GoogleComputeMetadataConfiguration
Property Type Description

micronaut.application.gcp.metadata.enabled

boolean

Default value (true).

micronaut.application.gcp.metadata.metadata-url

java.lang.String

Default value ("http://metadata.google.internal/computeMetadata/v1/project/").

micronaut.application.gcp.metadata.project-metadata-url

java.lang.String

Default value ("http://metadata.google.internal/project/v1/project/").

micronaut.application.gcp.metadata.read-timeout

java.time.Duration

Default value (5 seconds).

micronaut.application.gcp.metadata.connect-timeout

java.time.Duration

Default value (2).

Security Config Properties

🔗
Table 89. Configuration Properties for TokenConfigurationProperties
Property Type Description

micronaut.security.token.enabled

boolean

Sets whether the configuration is enabled. Default value true.

micronaut.security.token.roles-name

java.lang.String

Name of the roles property. Default value "roles".

🔗
Table 90. Configuration Properties for LogoutControllerConfigurationProperties
Property Type Description

micronaut.security.endpoints.logout.enabled

boolean

Enables LogoutController. Default value false.

micronaut.security.endpoints.logout.path

java.lang.String

Path to the LogoutController. Default value "/logout".

🔗
Table 91. Configuration Properties for HttpHeaderTokenWriterConfigurationProperties
Property Type Description

micronaut.security.token.writer.header.prefix

java.lang.String

Value prefix for Http Header. Default value ("Bearer").

micronaut.security.token.writer.header.header-name

java.lang.String

Http Header to be used to propagate the token. Default value "Authorization"

micronaut.security.token.writer.header.enabled

boolean

Enable HttpHeaderTokenWriter. Default value (true).

🔗
Table 92. Configuration Properties for LoginControllerConfigurationProperties
Property Type Description

micronaut.security.endpoints.login.enabled

boolean

Enables LoginController. Default value false

micronaut.security.endpoints.login.path

java.lang.String

Path to the LoginController. Default value "/login"

🔗
Table 93. Configuration Properties for SecurityConfigurationProperties
Property Type Description

micronaut.security.enabled

boolean

If Security is enabled. Default value false

micronaut.security.intercept-url-map

java.util.List

Map that defines the interception patterns.

micronaut.security.ip-patterns

java.util.List

Allowed IP patterns. Default value (["0.0.0.0"])

🔗
Table 94. Configuration Properties for TokenPropagationConfigurationProperties
Property Type Description

micronaut.security.token.propagation.enabled

boolean

Enables TokenPropagationHttpClientFilter. Default value false

micronaut.security.token.propagation.service-id-regex

java.lang.String

a regular expression to match the service id.

micronaut.security.token.propagation.uri-regex

java.lang.String

a regular expression to match the uri.

micronaut.security.token.propagation.path

java.lang.String

Configures TokenPropagationHttpClientFilter path. Default value "/**"

🔗
Table 95. Configuration Properties for BasicAuthTokenReaderConfigurationProperties
Property Type Description

micronaut.security.token.basic-auth.enabled

boolean

Enables BasicAuthTokenReader. Default value true.

micronaut.security.token.basic-auth.header-name

java.lang.String

Http Header name. Default value "Authorization".

micronaut.security.token.basic-auth.prefix

java.lang.String

Http Header value prefix. Default value "Basic".

Security Jwt Config Properties

🔗
Table 96. Configuration Properties for JwtCookieConfigurationProperties
Property Type Description

micronaut.security.token.jwt.cookie.enabled

boolean

Sets whether JWT cookie based security is enabled. Default value (false).

micronaut.security.token.jwt.cookie.logout-target-url

java.lang.String

Sets the logout target URL. Default value ("/").

micronaut.security.token.jwt.cookie.cookie-name

java.lang.String

Sets the cookie name to use. Default value ("JWT").

micronaut.security.token.jwt.cookie.login-success-target-url

java.lang.String

Sets the login success target URL. Default value ("/").

micronaut.security.token.jwt.cookie.login-failure-target-url

java.lang.String

Sets the login failure target URL. Default value ("/").

🔗
Table 97. Configuration Properties for JwtGeneratorConfigurationProperties
Property Type Description

micronaut.security.token.jwt.generator.refresh-token-expiration

java.lang.Integer

Refresh token expiration. By default refresh tokens, do not expire.

micronaut.security.token.jwt.generator.access-token-expiration

java.lang.Integer

Access token expiration. Default value (3600).

🔗
Table 98. Configuration Properties for OauthControllerConfigurationProperties
Property Type Description

micronaut.security.endpoints.oauth.enabled

boolean

Sets whether the OauthController is enabled. Default value (false).

micronaut.security.endpoints.oauth.path

java.lang.String

Sets the path to map the OauthController to. Default value ("/oauth/access_token").

🔗
Table 99. Configuration Properties for SecretSignatureConfiguration
Property Type Description

micronaut.security.token.jwt.signatures.secret.*.jws-algorithm

com.nimbusds.jose.JWSAlgorithm

{@link com.nimbusds.jose.JWSAlgorithm}. Defaults to HS256

micronaut.security.token.jwt.signatures.secret.*.secret

java.lang.String

Secret used to sign JWT. Length must be at least 256 bits.

micronaut.security.token.jwt.signatures.secret.*.base64

boolean

Indicates whether the supplied secret is base64 encoded.

🔗
Table 100. Configuration Properties for JwtConfigurationProperties
Property Type Description

micronaut.security.token.jwt.enabled

boolean

Sets whether JWT security is enabled. Default value (false).

🔗
Table 101. Configuration Properties for SecretEncryptionConfiguration
Property Type Description

micronaut.security.token.jwt.encryptions.secret.*.jwe-algorithm

com.nimbusds.jose.JWEAlgorithm

{@link com.nimbusds.jose.JWEAlgorithm}.

micronaut.security.token.jwt.encryptions.secret.*.encryption-method

com.nimbusds.jose.EncryptionMethod

{@link com.nimbusds.jose.EncryptionMethod}.

micronaut.security.token.jwt.encryptions.secret.*.secret

java.lang.String

Secret used for encryption configuration.

🔗
Table 102. Configuration Properties for BearerTokenConfigurationProperties
Property Type Description

micronaut.security.token.jwt.bearer.enabled

boolean

Set whether to enable basic auth. Default value true

micronaut.security.token.jwt.bearer.header-name

java.lang.String

Sets the header name to use. Default value "Authorization".

micronaut.security.token.jwt.bearer.prefix

java.lang.String

Sets the prefix to use for the auth token. Default value "Bearer"

Security Ldap Config Properties

🔗
Table 103. Configuration Properties for LdapConfiguration$SearchConfiguration
Property Type Description

micronaut.security.ldap.*.search.subtree

boolean

Sets if the subtree should be searched. Default true

micronaut.security.ldap.*.search.base

java.lang.String

Sets the base DN to search.

micronaut.security.ldap.*.search.filter

java.lang.String

Sets the search filter. Default "(uid={0})"

micronaut.security.ldap.*.search.attributes

java.lang.String[]

Sets the attributes to return. Default all

🔗
Table 104. Configuration Properties for LdapConfiguration$GroupConfiguration
Property Type Description

micronaut.security.ldap.*.groups.enabled

boolean

Sets if group search is enabled. Default false

micronaut.security.ldap.*.groups.subtree

boolean

Sets if the subtree should be searched. Default true

micronaut.security.ldap.*.groups.base

java.lang.String

Sets the base DN to search from.

micronaut.security.ldap.*.groups.filter

java.lang.String

Sets the group search filter. Default "uniquemember={0}"

micronaut.security.ldap.*.groups.attribute

java.lang.String

Sets the group attribute name. Default "cn"

🔗
Table 105. Configuration Properties for LdapConfiguration
Property Type Description

micronaut.security.ldap.*.enabled

boolean

Sets whether this configuration is enabled. Default true.

🔗
Table 106. Configuration Properties for LdapConfiguration$ContextConfiguration
Property Type Description

micronaut.security.ldap.*.context.server

java.lang.String

Sets the server URL.

micronaut.security.ldap.*.context.manager-dn

java.lang.String

Sets the manager DN.

micronaut.security.ldap.*.context.manager-password

java.lang.String

Sets the manager password.

micronaut.security.ldap.*.context.factory

java.lang.String

Sets the context factory class. Default "com.sun.jndi.ldap.LdapCtxFactory"

Security Session Config Properties

🔗
Table 107. Configuration Properties for SecuritySessionConfigurationProperties
Property Type Description

micronaut.security.session.login-success-target-url

java.lang.String

Sets the login success target URL. Default value ("/").

micronaut.security.session.login-failure-target-url

java.lang.String

Sets the login failure target URL. Default value ("/").

micronaut.security.session.logout-target-url

java.lang.String

Sets the logout target URL. Default value ("/").

micronaut.security.session.unauthorized-target-url

java.lang.String

Sets the unauthorized target URL.

micronaut.security.session.forbidden-target-url

java.lang.String

Sets the forbidden target URL.

micronaut.security.session.enabled

boolean

Sets whether the session config is enabled. Default value (false).

Session Config Properties

🔗
Table 108. Configuration Properties for HttpSessionConfiguration
Property Type Description

micronaut.session.http.base64encode

boolean

Default value (true).

micronaut.session.http.cookie-name

java.lang.String

Default value ("SESSION").

micronaut.session.http.prefix

java.lang.String

Set the prefix to use when serializing session ID

micronaut.session.http.header-names

java.lang.String[]

Default values (["Authorization-Info", "X-Auth-Token"]).

micronaut.session.http.cookie-path

java.lang.String

Set the cookie path to use

micronaut.session.http.domain-name

java.lang.String

Set the domain name to use for the cookie

micronaut.session.http.cookie-max-age

java.time.temporal.TemporalAmount

Set the max age to use for the cookie

micronaut.session.http.remember-me

boolean

Default value (false).

🔗
Table 109. Configuration Properties for SessionConfiguration
Property Type Description

micronaut.session.max-inactive-interval

java.time.Duration

Set the max active sessions.

micronaut.session.max-active-sessions

java.lang.Integer

Sets the maximum number of active sessions. Default value (30 seconds).

Tracing Config Properties

🔗
Table 110. Configuration Properties for JaegerConfiguration$JaegerSamplerConfiguration
Property Type Description

tracing.jaeger.sampler.probability

float

Sets the sampler probability used by the default {@link brave.sampler.CountingSampler}. A value of 1.0 indicates to sample all requests. A value of 0.1 indicates to sample 10% of requests.

🔗
Table 111. Configuration Properties for BraveTracerConfiguration$SamplerConfiguration
Property Type Description

tracing.zipkin.sampler.log-spans

java.lang.Boolean

tracing.zipkin.sampler.flush-interval

java.lang.Integer

tracing.zipkin.sampler.max-queue-size

java.lang.Integer

tracing.zipkin.sampler.sender

io.jaegertracing.Configuration$SenderConfiguration

tracing.zipkin.sampler.tracer-tags

java.util.Map

tracing.zipkin.sampler.metrics

zipkin2.reporter.ReporterMetrics

tracing.zipkin.sampler.message-max-bytes

int

tracing.zipkin.sampler.message-timeout

java.time.Duration

tracing.zipkin.sampler.close-timeout

java.time.Duration

tracing.zipkin.sampler.queued-max-spans

int

tracing.zipkin.sampler.queued-max-bytes

int

tracing.zipkin.sampler.build

zipkin2.codec.BytesEncoder

tracing.zipkin.sampler.local-service-name

java.lang.String

tracing.zipkin.sampler.local-ip

java.lang.String

tracing.zipkin.sampler.local-port

int

tracing.zipkin.sampler.trace-id128bit

boolean

tracing.zipkin.sampler.supports-join

boolean

tracing.zipkin.sampler.add-finished-span-handler

brave.handler.FinishedSpanHandler

tracing.zipkin.sampler.type

java.lang.String

tracing.zipkin.sampler.param

java.lang.Number

tracing.zipkin.sampler.manager-host-port

java.lang.String

tracing.zipkin.sampler.agent-host

java.lang.String

tracing.zipkin.sampler.agent-port

java.lang.Integer

tracing.zipkin.sampler.endpoint

java.lang.String

tracing.zipkin.sampler.auth-token

java.lang.String

tracing.zipkin.sampler.auth-username

java.lang.String

tracing.zipkin.sampler.auth-password

java.lang.String

tracing.zipkin.sampler.encoding

zipkin2.codec.Encoding

tracing.zipkin.sampler.compression-enabled

boolean

tracing.zipkin.sampler.server

java.net.URI

tracing.zipkin.sampler.url

java.net.URI

tracing.zipkin.sampler.urls

java.util.List

tracing.zipkin.sampler.probability

float

Sets the sampler probability used by the default {@link brave.sampler.CountingSampler}. A value of 1.0 indicates to sample all requests. A value of 0.1 indicates to sample 10% of requests.

🔗
Table 112. Configuration Properties for BraveTracerConfiguration
Property Type Description

tracing.zipkin.enabled

boolean

Default value (false).

🔗
Table 113. Configuration Properties for JaegerConfiguration
Property Type Description

tracing.jaeger.enabled

boolean

Enable/Disable Jaeger. Default value (false).

tracing.jaeger.expand-exception-logs

boolean

Whether to expand exception logs.

tracing.jaeger.zipkin-shared-rpc-span

boolean

Whether to use Zipkin shared RPC.

🔗
Table 114. Configuration Properties for BraveTracerConfiguration$HttpClientSenderConfiguration
Property Type Description

tracing.zipkin.http.ssl-configuration

SslConfiguration

tracing.zipkin.http.logger-name

java.lang.String

tracing.zipkin.http.follow-redirects

boolean

tracing.zipkin.http.default-charset

java.nio.charset.Charset

tracing.zipkin.http.channel-options

java.util.Map

tracing.zipkin.http.shutdown-timeout

java.time.Duration

tracing.zipkin.http.read-timeout

java.time.Duration

tracing.zipkin.http.read-idle-timeout

java.time.Duration

tracing.zipkin.http.connect-timeout

java.time.Duration

tracing.zipkin.http.num-of-threads

java.lang.Integer

tracing.zipkin.http.thread-factory

java.lang.Class

tracing.zipkin.http.max-content-length

int

tracing.zipkin.http.proxy-type

java.net.Proxy$Type

tracing.zipkin.http.proxy-address

java.net.SocketAddress

tracing.zipkin.http.proxy-username

java.lang.String

tracing.zipkin.http.proxy-password

java.lang.String

Views Config Properties

🔗
Table 115. Configuration Properties for ThymeleafViewsRendererConfigurationProperties
Property Type Description

micronaut.views.thymeleaf.enabled

boolean

Sets whether thymeleaf rendering is enabled. Default value (true).

micronaut.views.thymeleaf.character-encoding

java.lang.String

Sets the character encoding to use. Default value ("UTF-8").

micronaut.views.thymeleaf.template-mode

org.thymeleaf.templatemode.TemplateMode

Sets the template mode.

micronaut.views.thymeleaf.suffix

java.lang.String

Sets the suffix to use.

micronaut.views.thymeleaf.force-suffix

boolean

Sets whether to force the suffix. Default value (false).

micronaut.views.thymeleaf.force-template-mode

boolean

Sets whether to force template mode. Default value (false).

micronaut.views.thymeleaf.cacheable

boolean

Sets whether templates are cacheable.

micronaut.views.thymeleaf.cache-ttlms

java.lang.Long

Sets the cache TTL in millis.

micronaut.views.thymeleaf.check-existence

boolean

Sets whether templates should be checked for existence.

micronaut.views.thymeleaf.cache-ttl

java.time.Duration

Sets the cache TTL as a duration.

🔗
Table 116. Configuration Properties for HandlebarsViewsRendererConfigurationProperties
Property Type Description

micronaut.views.handlebars.enabled

boolean

Whether handlebars view rendering is enabled. Default value (true).

micronaut.views.handlebars.default-extension

java.lang.String

The default extension. Default value ("hbs").

🔗
Table 117. Configuration Properties for ViewsConfigurationProperties
Property Type Description

micronaut.views.enabled

boolean

Whether view rendering is enabled. Default value (true).

micronaut.views.folder

java.lang.String

The folder to look for views.

micronaut.views.dir

java.lang.String

The folder to look for views. Default value ("views").

🔗
Table 118. Configuration Properties for VelocityViewsRendererConfigurationProperties
Property Type Description

micronaut.views.velocity.enabled

boolean

Whether velocity views are enabled. Default value (true).

micronaut.views.velocity.default-extension

java.lang.String

Sets the defautlt extension to use for velocity templates. Default value ("vm").