Configuration Reference

Version:1.1.0.RC1

Cassandra Config Properties

🔗
Table 1. 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

boolean

cassandra.*.ssl

boolean

cassandra.*.initial-listeners

java.util.Collection

cassandra.*.out-jmxreporting

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 2. 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.ip-addr

java.lang.String

aws.route53.registration.prefer-ip-address

boolean

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 3. Configuration Properties for EurekaConfiguration$EurekaRegistrationConfiguration
Property Type Description

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.prefer-ip-address

boolean

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 4. Configuration Properties for DiscoveryClientCacheConfiguration
Property Type Description

micronaut.caches.*.discovery-client.enabled

boolean

Enable or disable the discovery client

🔗
Table 5. 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 6. 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 7. 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 8. Configuration Properties for SpringCloudConfigConfiguration$SpringConfigDiscoveryConfiguration
Property Type Description

spring.cloud.config.config.enabled

boolean

spring.cloud.config.config.path

java.lang.String

spring.cloud.config.config.format

ConfigDiscoveryConfiguration$Format

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

consul.client.registration.tags

java.util.List

The tags for registering the service

consul.client.registration.ip-addr

java.lang.String

consul.client.registration.prefer-ip-address

boolean

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 10. 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 11. 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.should-use-dns

boolean

Whether DNS should be used to resolve the discovery servers.

aws.route53.discovery.client.context-path

java.lang.String

Sets the context path.

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 12. Configuration Properties for ConsulConfiguration
Property Type Description

consul.client.asl-token

java.lang.String

The asl token

consul.client.health-check

boolean

Sets whether the Consul server should be considered for health checks. @see io.micronaut.discovery.consul.health.ConsulHealthIndicator

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.should-use-dns

boolean

Whether DNS should be used to resolve the discovery servers.

consul.client.context-path

java.lang.String

Sets the context path.

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 13. 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 14. Configuration Properties for AWSParameterStoreConfiguration
Property Type Description

aws.client.system-manager.parameterstore.protocol

com.amazonaws.Protocol

aws.client.system-manager.parameterstore.max-connections

int

aws.client.system-manager.parameterstore.user-agent-prefix

java.lang.String

aws.client.system-manager.parameterstore.user-agent-suffix

java.lang.String

aws.client.system-manager.parameterstore.local-address

java.net.InetAddress

aws.client.system-manager.parameterstore.proxy-protocol

com.amazonaws.Protocol

aws.client.system-manager.parameterstore.proxy-host

java.lang.String

aws.client.system-manager.parameterstore.proxy-port

int

aws.client.system-manager.parameterstore.disable-socket-proxy

boolean

aws.client.system-manager.parameterstore.proxy-username

java.lang.String

aws.client.system-manager.parameterstore.proxy-password

java.lang.String

aws.client.system-manager.parameterstore.proxy-domain

java.lang.String

aws.client.system-manager.parameterstore.proxy-workstation

java.lang.String

aws.client.system-manager.parameterstore.non-proxy-hosts

java.lang.String

aws.client.system-manager.parameterstore.proxy-authentication-methods

java.util.List

aws.client.system-manager.parameterstore.retry-policy

com.amazonaws.retry.RetryPolicy

aws.client.system-manager.parameterstore.max-error-retry

int

aws.client.system-manager.parameterstore.socket-timeout

int

aws.client.system-manager.parameterstore.connection-timeout

int

aws.client.system-manager.parameterstore.request-timeout

int

aws.client.system-manager.parameterstore.client-execution-timeout

int

aws.client.system-manager.parameterstore.use-reaper

boolean

aws.client.system-manager.parameterstore.use-throttle-retries

boolean

aws.client.system-manager.parameterstore.max-consecutive-retries-before-throttling

int

aws.client.system-manager.parameterstore.use-gzip

boolean

aws.client.system-manager.parameterstore.signer-override

java.lang.String

aws.client.system-manager.parameterstore.preemptive-basic-proxy-auth

java.lang.Boolean

aws.client.system-manager.parameterstore.connection-ttl

long

aws.client.system-manager.parameterstore.connection-max-idle-millis

long

aws.client.system-manager.parameterstore.validate-after-inactivity-millis

int

aws.client.system-manager.parameterstore.use-tcp-keep-alive

boolean

aws.client.system-manager.parameterstore.dns-resolver

com.amazonaws.DnsResolver

aws.client.system-manager.parameterstore.cache-response-metadata

boolean

aws.client.system-manager.parameterstore.response-metadata-cache-size

int

aws.client.system-manager.parameterstore.secure-random

java.security.SecureRandom

aws.client.system-manager.parameterstore.use-expect-continue

boolean

aws.client.system-manager.parameterstore.disable-host-prefix-injection

boolean

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 15. Configuration Properties for SpringCloudConfigConfiguration$SpringCloudConnectionPoolConfiguration
Property Type Description

spring.cloud.config.pool.enabled

boolean

spring.cloud.config.pool.max-connections

int

spring.cloud.config.pool.max-pending-acquires

int

spring.cloud.config.pool.acquire-timeout

java.time.Duration

🔗
Table 16. 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 17. 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.should-use-dns

boolean

Whether DNS should be used to resolve the discovery servers.

eureka.client.context-path

java.lang.String

Sets the context path.

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

🔗
Table 18. Configuration Properties for SpringCloudConfigConfiguration
Property Type Description

spring.cloud.config.uri

java.lang.String

Set the Spring Cloud config server uri.

spring.cloud.config.ssl-configuration

SslConfiguration

spring.cloud.config.logger-name

java.lang.String

spring.cloud.config.follow-redirects

boolean

spring.cloud.config.default-charset

java.nio.charset.Charset

spring.cloud.config.channel-options

java.util.Map

spring.cloud.config.shutdown-timeout

java.time.Duration

spring.cloud.config.read-timeout

java.time.Duration

spring.cloud.config.read-idle-timeout

java.time.Duration

spring.cloud.config.connect-timeout

java.time.Duration

spring.cloud.config.num-of-threads

java.lang.Integer

spring.cloud.config.thread-factory

java.lang.Class

spring.cloud.config.max-content-length

int

spring.cloud.config.proxy-type

java.net.Proxy$Type

spring.cloud.config.proxy-address

java.net.SocketAddress

spring.cloud.config.proxy-username

java.lang.String

spring.cloud.config.proxy-password

java.lang.String

🔗
Table 19. 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).

Function Client Config Properties

🔗
Table 20. Configuration Properties for AWSLambdaConfiguration
Property Type Description

aws.lambda.executor-factory

com.amazonaws.client.builder.ExecutorFactory

aws.lambda.credentials

com.amazonaws.auth.AWSCredentialsProvider

aws.lambda.client-configuration

com.amazonaws.ClientConfiguration

aws.lambda.metrics-collector

com.amazonaws.metrics.RequestMetricCollector

aws.lambda.region

com.amazonaws.regions.Regions

aws.lambda.endpoint-configuration

com.amazonaws.client.builder.AwsClientBuilder$EndpointConfiguration

aws.lambda.request-handlers

com.amazonaws.handlers.RequestHandler2[]

aws.lambda.monitoring-listener

com.amazonaws.monitoring.MonitoringListener

aws.lambda.client-side-monitoring-configuration-provider

com.amazonaws.monitoring.CsmConfigurationProvider

🔗
Table 21. Configuration Properties for AWSInvokeRequestDefinition
Property Type Description

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

Http Client Config Properties

🔗
Table 22. 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.

🔗
Table 23. Configuration Properties for NamedClientVersioningConfiguration
Property Type Description

micronaut.http.client.versioning.*.headers

java.util.List

The list of request header names.

micronaut.http.client.versioning.*.parameters

java.util.List

The list of request query parameter names.

🔗
Table 24. 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 25. Configuration Properties for DefaultClientVersioningConfiguration
Property Type Description

micronaut.http.client.versioning.default.headers

java.util.List

The list of request header names.

micronaut.http.client.versioning.default.parameters

java.util.List

The list of request query parameter names.

🔗
Table 26. 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 27. 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.

Http Config Properties

🔗
Table 28. 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 29. 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 30. 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 31. 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 32. 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 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 CodecConfiguration
Property Type Description

micronaut.codec.*.additional-types

java.util.List

Default value (Empty list).

🔗
Table 35. 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 36. 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 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.

🔗
Table 38. 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 39. 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 40. 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.

Http Server Config Properties

🔗
Table 41. 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).

micronaut.server.multipart.mixed

boolean

Sets whether to buffer data to disk if the size is greater than the threshold. Default value (false).

micronaut.server.multipart.threshold

long

Sets the amount of data that should be received that will trigger the data to be stored to disk. Default value (1024 * 1024 * 10).

🔗
Table 42. 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 43. 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 44. Configuration Properties for FileTypeHandlerConfiguration
Property Type Description

netty.responses.file.cache-seconds

int

Cache Seconds. Default value (60).

🔗
Table 45. 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 46. 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.

micronaut.server.netty.compression-threshold

int

Sets the minimum size of a request body must be in order to be compressed. Default value (1024).

micronaut.server.netty.use-native-transport

boolean

Sets whether to use netty’s native transport (epoll or kqueue) if available . Default value (false).

🔗
Table 47. 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.

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.

Management Config Properties

🔗
Table 49. 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 50. Configuration Properties for HealthEndpoint
Property Type Description

endpoints.health.details-visible

DetailsVisibility

Sets the visibility policy for health information.

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

endpoints.health.status.http-mapping

java.util.Map

Set how HealthStatus map to HttpStatus codes.

🔗
Table 52. 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).

🔗
Table 53. 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 ("/").

Multitenancy Config Properties

🔗
Table 54. 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").

🔗
Table 55. Configuration Properties for SubdomainTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.subdomain.enabled

boolean

Enables SubdomainTenantResolver. Default value (false).

🔗
Table 56. Configuration Properties for PrincipalTenantResolverConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantresolver.principal.enabled

boolean

Enables PrincipalTenantResolver. The default enable is false.

🔗
Table 57. 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 58. Configuration Properties for CookieTenantWriterConfigurationProperties
Property Type Description

micronaut.multitenancy.tenantwriter.cookie.cookiename

java.lang.String

Cookie Name. Default value ("tenantId").

micronaut.multitenancy.tenantwriter.cookie.cookie-domain

java.lang.String

Sets the domain name of this Cookie. Default value ("tenantId").

micronaut.multitenancy.tenantwriter.cookie.cookie-path

java.lang.String

Sets the path of the cookie. Default value ({@value DEFAULT_COOKIEPATH}.

micronaut.multitenancy.tenantwriter.cookie.cookie-http-only

java.lang.Boolean

Whether the Cookie can only be accessed via HTTP. Default value ({@value DEFAULT_HTTPONLY}.

micronaut.multitenancy.tenantwriter.cookie.cookie-secure

java.lang.Boolean

Sets whether the cookie is secured. Default value ({@value DEFAULT_SECURE}.

micronaut.multitenancy.tenantwriter.cookie.cookie-max-age

java.time.temporal.TemporalAmount

Sets the maximum age of the cookie.

micronaut.multitenancy.tenantwriter.cookie.enabled

boolean

Enables CookieTenantWriter. Default value (false).

🔗
Table 59. 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 60. 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 61. 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 62. 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 63. 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).

Router Config Properties

🔗
Table 64. Configuration Properties for HeaderVersionResolverConfiguration
Property Type Description

micronaut.router.versioning.header.enabled

boolean

Sets whether headers should be searched for a version.

micronaut.router.versioning.header.names

java.util.List

Sets which headers should be searched for a version.

🔗
Table 65. Configuration Properties for ParameterVersionResolverConfiguration
Property Type Description

micronaut.router.versioning.parameter.enabled

boolean

Sets whether parameter should be searched for a version.

micronaut.router.versioning.parameter.names

java.util.List

Sets which parameter should be searched for a version.

🔗
Table 66. 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 ("/**").

🔗
Table 67. Configuration Properties for RoutesVersioningConfiguration
Property Type Description

micronaut.router.versioning.enabled

boolean

Enables the version based route matches filtering.

Runtime Config Properties

🔗
Table 68. Configuration Properties for DefaultCacheConfiguration
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.*.record-stats

boolean

Set whether record stats is enabled. Default value ({@value #DEFAULT_RECORD_STATS}).

micronaut.caches.*.test-mode

boolean

Set whether test mode is enabled. Default value ({@value #DEFAULT_TESTMODE}).

🔗
Table 69. 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 70. Configuration Properties for DigitalOceanMetadataConfiguration
Property Type Description

micronaut.application.digitalocean.metadata.url

java.lang.String

Default value ("http://169.254.169.254/metadata/v1.json").

micronaut.application.digitalocean.metadata.enabled

boolean

Default value (true).

🔗
Table 71. 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 72. Configuration Properties for FileWatchConfiguration
Property Type Description

micronaut.io.watch.enabled

boolean

Whether watch is enabled.

micronaut.io.watch.restart

boolean

Set whether restart is enabled.

micronaut.io.watch.paths

java.util.List

Sets the watch paths to use.

micronaut.io.watch.check-interval

java.time.Duration

Sets the interval to wait between file watch polls.

🔗
Table 73. 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 74. Configuration Properties for JacksonConfiguration
Property Type Description

jackson.module-scan

boolean

Sets whether to scan for modules or not (defaults to true).

jackson.bean-introspection-module

boolean

Whether the BeanIntrospection should be used for reflection free object serialialization/deserialialization.

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.

jackson.default-typing

com.fasterxml.jackson.databind.ObjectMapper$DefaultTyping

Sets the global defaultTyping using for Polymorphic handling.

jackson.property-naming-strategy

com.fasterxml.jackson.databind.PropertyNamingStrategy

Sets the property naming strategy.

🔗
Table 75. 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 76. 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).

🔗
Table 77. 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

Security Config Properties

🔗
Table 78. 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 79. Configuration Properties for RedirectRejectionHandlerConfigurationProperties
Property Type Description

micronaut.security.redirect.enabled

boolean

Enables RedirectRejectionHandler. Default value true.

micronaut.security.redirect.http-status

HttpStatus

The Http status used used for redirection. Defaults value (303).

🔗
Table 80. 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 TokenConfiguration.DEFAULT_ROLES_NAME.

🔗
Table 81. 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".

micronaut.security.endpoints.logout.get-allowed

boolean

Enables HTTP GET invocations of LogoutController. Default value (false).

🔗
Table 82. 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 83. 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 84. 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".

🔗
Table 85. 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"])

Security Jwt Config Properties

🔗
Table 86. 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 87. 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 88. 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 89. Configuration Properties for BearerTokenConfigurationProperties
Property Type Description

micronaut.security.token.jwt.bearer.enabled

boolean

Set whether to enable bearer token authentication. 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".

🔗
Table 90. Configuration Properties for KeysControllerConfigurationProperties
Property Type Description

micronaut.security.endpoints.keys.enabled

boolean

Enables KeysController. Default value false.

micronaut.security.endpoints.keys.path

java.lang.String

Path to the KeysController. Default value "/keys".

🔗
Table 91. Configuration Properties for JwtCookieConfigurationProperties
Property Type Description

micronaut.security.token.jwt.cookie.cookie-domain

java.lang.String

Sets the domain name of this Cookie. Default value ("JWT").

micronaut.security.token.jwt.cookie.cookie-path

java.lang.String

Sets the path of the cookie. Default value ({@value DEFAULT_COOKIEPATH}.

micronaut.security.token.jwt.cookie.cookie-http-only

java.lang.Boolean

Whether the Cookie can only be accessed via HTTP. Default value ({@value DEFAULT_HTTPONLY}.

micronaut.security.token.jwt.cookie.cookie-secure

java.lang.Boolean

Sets whether the cookie is secured. Default value ({@value DEFAULT_SECURE}.

micronaut.security.token.jwt.cookie.cookie-max-age

java.time.temporal.TemporalAmount

Sets the maximum age of the cookie.

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

Cookie Name. 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 92. Configuration Properties for JwksSignatureConfigurationProperties
Property Type Description

micronaut.security.token.jwt.signatures.jwks.*.url

java.lang.String

Remote JSON Web Key set url. e.g. https://…​/.well-known/jwks.json

micronaut.security.token.jwt.signatures.jwks.*.key-type

com.nimbusds.jose.jwk.KeyType

Representation of the kty parameter in a JSON Web Key (JWK). Default value (RSA).

🔗
Table 93. 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 94. Configuration Properties for JwtConfigurationProperties
Property Type Description

micronaut.security.token.jwt.enabled

boolean

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

Security Ldap Config Properties

🔗
Table 95. Configuration Properties for LdapConfiguration
Property Type Description

micronaut.security.ldap.*.enabled

boolean

Sets whether this configuration is enabled. Default true.

🔗
Table 96. 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 97. 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"

🔗
Table 98. 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

Security Session Config Properties

🔗
Table 99. 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).

micronaut.security.session.legacy-rejection-handler

boolean

Decides whether the deprecated {@link SessionSecurityFilterOrderProvider} is loaded, instead of the new RedirectRejectionHandler. Defaults to (#DEFAULT_LEGACYREJECTIONHANDLER).

Session Config Properties

🔗
Table 100. Configuration Properties for HttpSessionConfiguration
Property Type Description

micronaut.session.http.remember-me

boolean

Default value (false).

micronaut.session.http.base64encode

boolean

Default value (true).

micronaut.session.http.cookie-max-age

java.time.temporal.TemporalAmount

Set the max age to use for the cookie

micronaut.session.http.cookie-path

java.lang.String

Set the cookie path to use. Default value ({@value DEFAULT_COOKIEPATH}).

micronaut.session.http.domain-name

java.lang.String

Set the domain name to use for the cookie

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"]).

🔗
Table 101. 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 102. Configuration Properties for JaegerConfiguration
Property Type Description

tracing.jaeger.tracer-tags

java.util.Map

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 103. Configuration Properties for JaegerConfiguration$JaegerSenderConfiguration
Property Type Description

tracing.jaeger.sender.agent-host

java.lang.String

tracing.jaeger.sender.agent-port

java.lang.Integer

tracing.jaeger.sender.endpoint

java.lang.String

tracing.jaeger.sender.auth-token

java.lang.String

tracing.jaeger.sender.auth-username

java.lang.String

tracing.jaeger.sender.auth-password

java.lang.String

🔗
Table 104. Configuration Properties for AsyncReporterConfiguration
Property Type Description

tracing.zipkin.reporter.metrics

zipkin2.reporter.ReporterMetrics

tracing.zipkin.reporter.message-max-bytes

int

tracing.zipkin.reporter.message-timeout

java.time.Duration

tracing.zipkin.reporter.close-timeout

java.time.Duration

tracing.zipkin.reporter.queued-max-spans

int

tracing.zipkin.reporter.queued-max-bytes

int

tracing.zipkin.reporter.build

zipkin2.codec.BytesEncoder

🔗
Table 105. Configuration Properties for JaegerConfiguration$JaegerReporterConfiguration
Property Type Description

tracing.jaeger.reporter.log-spans

java.lang.Boolean

tracing.jaeger.reporter.flush-interval

java.lang.Integer

tracing.jaeger.reporter.max-queue-size

java.lang.Integer

tracing.jaeger.reporter.sender

io.jaegertracing.Configuration$SenderConfiguration

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

tracing.zipkin.http.encoding

zipkin2.codec.Encoding

tracing.zipkin.http.message-max-bytes

int

tracing.zipkin.http.compression-enabled

boolean

tracing.zipkin.http.server

java.net.URI

tracing.zipkin.http.url

java.net.URI

tracing.zipkin.http.urls

java.util.List

tracing.zipkin.http.build

javax.inject.Provider

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

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

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 108. Configuration Properties for JaegerConfiguration$JaegerSamplerConfiguration
Property Type Description

tracing.jaeger.sampler.type

java.lang.String

tracing.jaeger.sampler.param

java.lang.Number

tracing.jaeger.sampler.manager-host-port

java.lang.String

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 109. Configuration Properties for BraveTracerConfiguration
Property Type Description

tracing.zipkin.local-service-name

java.lang.String

tracing.zipkin.local-ip

java.lang.String

tracing.zipkin.local-port

int

tracing.zipkin.trace-id128bit

boolean

tracing.zipkin.supports-join

boolean

tracing.zipkin.add-finished-span-handler

brave.handler.FinishedSpanHandler

tracing.zipkin.enabled

boolean

Default value (false).

Views Config Properties

🔗
Table 110. 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 111. 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").

🔗
Table 112. Configuration Properties for SecurityViewModelProcessorConfigurationProperties
Property Type Description

micronaut.security.views-model-decorator.enabled

boolean

Enable {@link SecurityViewModelProcessor}. Default value (true).

micronaut.security.views-model-decorator.security-key

java.lang.String

Model key name. Default value ("security").

micronaut.security.views-model-decorator.principal-name-key

java.lang.String

Nested security map key for the user’s name property. Default value ("name").

micronaut.security.views-model-decorator.attributes-key

java.lang.String

Nested security map key for the user’s attributes property. Default value ("attributes").

🔗
Table 113. Configuration Properties for FreemarkerViewsRendererConfigurationProperties
Property Type Description

micronaut.views.freemarker.template-loader

freemarker.cache.TemplateLoader

micronaut.views.freemarker.template-lookup-strategy

freemarker.cache.TemplateLookupStrategy

micronaut.views.freemarker.template-name-format

freemarker.cache.TemplateNameFormat

micronaut.views.freemarker.template-configurations

freemarker.cache.TemplateConfigurationFactory

micronaut.views.freemarker.cache-storage

freemarker.cache.CacheStorage

micronaut.views.freemarker.directory-for-template-loading

java.io.File

micronaut.views.freemarker.template-update-delay-milliseconds

long

micronaut.views.freemarker.object-wrapper

freemarker.template.ObjectWrapper

micronaut.views.freemarker.locale

java.util.Locale

micronaut.views.freemarker.time-zone

java.util.TimeZone

micronaut.views.freemarker.template-exception-handler

freemarker.template.TemplateExceptionHandler

micronaut.views.freemarker.attempt-exception-reporter

freemarker.template.AttemptExceptionReporter

micronaut.views.freemarker.log-template-exceptions

boolean

micronaut.views.freemarker.wrap-unchecked-exceptions

boolean

micronaut.views.freemarker.incompatible-improvements

freemarker.template.Version

micronaut.views.freemarker.whitespace-stripping

boolean

micronaut.views.freemarker.auto-escaping-policy

int

micronaut.views.freemarker.output-format

freemarker.core.OutputFormat

micronaut.views.freemarker.registered-custom-output-formats

java.util.Collection

micronaut.views.freemarker.recognize-standard-file-extensions

boolean

micronaut.views.freemarker.tag-syntax

int

micronaut.views.freemarker.interpolation-syntax

int

micronaut.views.freemarker.naming-convention

int

micronaut.views.freemarker.tab-size

int

micronaut.views.freemarker.default-encoding

java.lang.String

micronaut.views.freemarker.shared-varibles

java.util.Map

micronaut.views.freemarker.all-shared-variables

freemarker.template.TemplateHashModelEx

micronaut.views.freemarker.localized-lookup

boolean

micronaut.views.freemarker.classic-compatible

boolean

micronaut.views.freemarker.classic-compatible-as-int

int

micronaut.views.freemarker.sqldate-and-time-time-zone

java.util.TimeZone

micronaut.views.freemarker.number-format

java.lang.String

micronaut.views.freemarker.custom-number-formats

java.util.Map

micronaut.views.freemarker.boolean-format

java.lang.String

micronaut.views.freemarker.time-format

java.lang.String

micronaut.views.freemarker.date-format

java.lang.String

micronaut.views.freemarker.date-time-format

java.lang.String

micronaut.views.freemarker.custom-date-formats

java.util.Map

micronaut.views.freemarker.arithmetic-engine

freemarker.core.ArithmeticEngine

micronaut.views.freemarker.output-encoding

java.lang.String

micronaut.views.freemarker.urlescaping-charset

java.lang.String

micronaut.views.freemarker.new-builtin-class-resolver

freemarker.core.TemplateClassResolver

micronaut.views.freemarker.auto-flush

boolean

micronaut.views.freemarker.show-error-tips

boolean

micronaut.views.freemarker.apibuiltin-enabled

boolean

micronaut.views.freemarker.lazy-imports

boolean

micronaut.views.freemarker.lazy-auto-imports

java.lang.Boolean

micronaut.views.freemarker.auto-imports

java.util.Map

micronaut.views.freemarker.auto-includes

java.util.List

micronaut.views.freemarker.settings

java.util.Properties

micronaut.views.freemarker.enabled

boolean

Whether freemarker views are enabled.

micronaut.views.freemarker.default-extension

java.lang.String

Sets the default extension to use.

🔗
Table 114. 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 115. Configuration Properties for CspConfiguration
Property Type Description

micronaut.views.csp.enabled

boolean

Sets whether CSP is enabled. Default false.

micronaut.views.csp.policy-directives

java.lang.String

Sets the policy directives.

micronaut.views.csp.report-only

boolean

If true, the Content-Security-Policy-Report-Only header will be sent instead of Content-Security-Policy. Default false.

micronaut.views.csp.filter-path

java.lang.String

Sets the path the CSP filter should apply to. Default value "/**".

🔗
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").