Micronaut AWS Configuration Reference

Every documented configuration property of Micronaut AWS, with types, descriptions, and defaults.

289 properties across 11 sections

Micronaut Aws Alexa Config Properties

Configuration properties for HandlerInputLocaleResolutionConfigurationProperties

Property	Type	Description
`alexa.locale-resolution.fixed`	java.util.Locale	Sets the fixed locale. Any of ar-SA, de-DE, en-AU, en-CA, en-GB, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, hi-IN, it-IT, ja-JP, pt-BR
`alexa.locale-resolution.default-locale`	java.util.Locale	Sets the locale that will be used if the locale cannot be resolved through any means. Defaults to "en-US".

Configuration properties for AlexaSkillConfigurationProperties

Property	Type	Description
`alexa.skills.*.enabled`	boolean	Sets whether this configuration is enabled. Default true.
`alexa.skills.*.skill-id`	java.lang.String	The Skill ID of this Alexa skill.

Micronaut Aws Alexa Httpserver Config Properties

Configuration properties for AlexaControllerConfigurationProperties

Property	Type	Description
`alexa.endpoint.path`	java.lang.String	Default value ("/alexa").
`alexa.endpoint.enabled`	boolean	Sets whether this configuration is enabled. Default true.

Micronaut Aws Common Config Properties

Configuration properties for AmazonMetadataConfiguration

Property	Type	Description
`micronaut.application.ec2.metadata.enabled`	boolean	Default value (true).
`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 Aws Distributed Configuration Config Properties

Configuration properties for AwsDistributedConfigurationProperties

Property	Type	Description
`aws.distributed-configuration.delimiter`	java.lang.String	Delimiter for AWS Distributed Configuration resources names. Default value ("/").
`aws.distributed-configuration.search-active-environments`	boolean	Search additional paths suffixed with each active environment. e.g. /config/application_ec2 Default value (true).
`aws.distributed-configuration.search-common-application`	boolean	Whether paths for the {@link AwsDistributedConfiguration#getCommonApplicationName()} should be searched or not. Default value (true).
`aws.distributed-configuration.prefixes`	java.util.List	List of prefixes for AWS Distributed Configuration resources names. If it is non-empty, {@link AwsDistributedConfiguration#getPrefix()} is not used.
`aws.distributed-configuration.prefix`	java.lang.String	Prefix for AWS Distributed Configuration resources names. Default ("/config/")
`aws.distributed-configuration.common-application-name`	java.lang.String	Default Application name. Default value ("application").

Micronaut Aws Parameter Store Config Properties

Configuration properties for AWSParameterStoreConfiguration

Property	Type	Description
`aws.client.system-manager.parameterstore.enabled`	boolean	Enable or disable distributed configuration with AWS Parameter Store. Default value (false).
`aws.client.system-manager.parameterstore.root-hierarchy-path`	java.lang.String	The the root hierarchy on the parameter store. Default value ("/" + PREFIX + "/").
`aws.client.system-manager.parameterstore.use-secure-parameters`	boolean	Use auto-decryption via KMS for SecureString parameters. Default value (false). If set to false, you will not get unencrypted values.
`aws.client.system-manager.parameterstore.search-active-environments`	boolean	Search additional paths suffixed with each active environment. e.g. /config/application_EC2 Default value (true).

Micronaut Aws Sdk V1 Config Properties

Configuration properties for ClientConfiguration

Property	Type	Description
`aws.client.protocol`	com.amazonaws.Protocol
`aws.client.max-connections`	int
`aws.client.user-agent-prefix`	java.lang.String
`aws.client.user-agent-suffix`	java.lang.String
`aws.client.local-address`	java.net.InetAddress
`aws.client.proxy-protocol`	com.amazonaws.Protocol
`aws.client.proxy-host`	java.lang.String
`aws.client.proxy-port`	int
`aws.client.disable-socket-proxy`	boolean
`aws.client.proxy-username`	java.lang.String
`aws.client.proxy-password`	java.lang.String
`aws.client.proxy-domain`	java.lang.String
`aws.client.proxy-workstation`	java.lang.String
`aws.client.non-proxy-hosts`	java.lang.String
`aws.client.proxy-authentication-methods`	java.util.List
`aws.client.retry-policy`	com.amazonaws.retry.RetryPolicy
`aws.client.max-error-retry`	int
`aws.client.retry-mode`	com.amazonaws.retry.RetryMode
`aws.client.account-id-endpoint-mode`	com.amazonaws.endpoints.AccountIdEndpointMode
`aws.client.socket-timeout`	int
`aws.client.connection-timeout`	int
`aws.client.request-timeout`	int
`aws.client.client-execution-timeout`	int
`aws.client.use-reaper`	boolean
`aws.client.use-throttle-retries`	boolean
`aws.client.max-consecutive-retries-before-throttling`	int
`aws.client.use-gzip`	boolean
`aws.client.signer-override`	java.lang.String
`aws.client.preemptive-basic-proxy-auth`	java.lang.Boolean
`aws.client.connection-ttl`	long
`aws.client.connection-max-idle-millis`	long
`aws.client.validate-after-inactivity-millis`	int
`aws.client.use-tcp-keep-alive`	boolean
`aws.client.dns-resolver`	com.amazonaws.DnsResolver
`aws.client.cache-response-metadata`	boolean
`aws.client.response-metadata-cache-size`	int
`aws.client.secure-random`	java.security.SecureRandom
`aws.client.use-expect-continue`	boolean
`aws.client.disable-host-prefix-injection`	boolean
`aws.client.tls-key-managers-provider`	com.amazonaws.http.TlsKeyManagersProvider

Configuration properties for ClientConfiguration

Property	Type	Description
`aws.client.protocol`	com.amazonaws.Protocol
`aws.client.max-connections`	int
`aws.client.user-agent-prefix`	java.lang.String
`aws.client.user-agent-suffix`	java.lang.String
`aws.client.local-address`	java.net.InetAddress
`aws.client.proxy-protocol`	com.amazonaws.Protocol
`aws.client.proxy-host`	java.lang.String
`aws.client.proxy-port`	int
`aws.client.disable-socket-proxy`	boolean
`aws.client.proxy-username`	java.lang.String
`aws.client.proxy-password`	java.lang.String
`aws.client.proxy-domain`	java.lang.String
`aws.client.proxy-workstation`	java.lang.String
`aws.client.non-proxy-hosts`	java.lang.String
`aws.client.proxy-authentication-methods`	java.util.List
`aws.client.retry-policy`	com.amazonaws.retry.RetryPolicy
`aws.client.max-error-retry`	int
`aws.client.retry-mode`	com.amazonaws.retry.RetryMode
`aws.client.account-id-endpoint-mode`	com.amazonaws.endpoints.AccountIdEndpointMode
`aws.client.socket-timeout`	int
`aws.client.connection-timeout`	int
`aws.client.request-timeout`	int
`aws.client.client-execution-timeout`	int
`aws.client.use-reaper`	boolean
`aws.client.use-throttle-retries`	boolean
`aws.client.max-consecutive-retries-before-throttling`	int
`aws.client.use-gzip`	boolean
`aws.client.signer-override`	java.lang.String
`aws.client.preemptive-basic-proxy-auth`	java.lang.Boolean
`aws.client.connection-ttl`	long
`aws.client.connection-max-idle-millis`	long
`aws.client.validate-after-inactivity-millis`	int
`aws.client.use-tcp-keep-alive`	boolean
`aws.client.dns-resolver`	com.amazonaws.DnsResolver
`aws.client.cache-response-metadata`	boolean
`aws.client.response-metadata-cache-size`	int
`aws.client.secure-random`	java.security.SecureRandom
`aws.client.use-expect-continue`	boolean
`aws.client.disable-host-prefix-injection`	boolean
`aws.client.tls-key-managers-provider`	com.amazonaws.http.TlsKeyManagersProvider

Micronaut Aws Sdk V2 Config Properties

Configuration properties for Apache5HttpClient$Builder

Property	Type	Description
`aws.apache-client.socket-timeout`	java.time.Duration
`aws.apache-client.connection-timeout`	java.time.Duration
`aws.apache-client.connection-acquisition-timeout`	java.time.Duration
`aws.apache-client.max-connections`	java.lang.Integer
`aws.apache-client.local-address`	java.net.InetAddress
`aws.apache-client.expect-continue-enabled`	java.lang.Boolean
`aws.apache-client.connection-time-to-live`	java.time.Duration
`aws.apache-client.connection-max-idle-time`	java.time.Duration
`aws.apache-client.use-idle-connection-reaper`	java.lang.Boolean
`aws.apache-client.tcp-keep-alive`	java.lang.Boolean

Configuration properties for ApacheHttpClient$Builder

Property	Type	Description
`aws.apache-client.dns-resolver`	org.apache.http.conn.DnsResolver
`aws.apache-client.socket-factory`	org.apache.http.conn.socket.ConnectionSocketFactory
`aws.apache-client.auth-scheme-provider-registry`	org.apache.http.config.Registry

Configuration properties for ProxyConfiguration$Builder

Property	Type	Description
`aws.apache-client.proxy.endpoint`	java.net.URI
`aws.apache-client.proxy.username`	java.lang.String
`aws.apache-client.proxy.password`	java.lang.String
`aws.apache-client.proxy.ntlm-domain`	java.lang.String
`aws.apache-client.proxy.ntlm-workstation`	java.lang.String
`aws.apache-client.proxy.non-proxy-hosts`	java.util.Set
`aws.apache-client.proxy.preemptive-basic-authentication-enabled`	java.lang.Boolean
`aws.apache-client.proxy.use-system-property-values`	java.lang.Boolean
`aws.apache-client.proxy.use-environment-variable-values`	java.lang.Boolean
`aws.apache-client.proxy.scheme`	java.lang.String

Configuration properties for ProxyConfiguration$Builder

Property	Type	Description
`aws.apache-client.proxy.add-non-proxy-host`	java.lang.String

Configuration properties for AwsCrtHttpClient$Builder

Property	Type	Description
`aws.crt-client.max-concurrency`	java.lang.Integer
`aws.crt-client.read-buffer-size-in-bytes`	java.lang.Long
`aws.crt-client.num-event-loop-threads`	java.lang.Integer
`aws.crt-client.connection-health-configuration`	software.amazon.awssdk.http.crt.ConnectionHealthConfiguration
`aws.crt-client.connection-max-idle-time`	java.time.Duration
`aws.crt-client.connection-timeout`	java.time.Duration
`aws.crt-client.connection-acquisition-timeout`	java.time.Duration
`aws.crt-client.tls-negotiation-timeout`	java.time.Duration
`aws.crt-client.tcp-keep-alive-configuration`	software.amazon.awssdk.http.crt.TcpKeepAliveConfiguration
`aws.crt-client.post-quantum-tls-enabled`	java.lang.Boolean
`aws.crt-client.min-tls-version`	software.amazon.awssdk.http.crt.TlsVersion

Configuration properties for AwsCrtAsyncHttpClient$Builder

Property	Type	Description
`aws.crt-client.protocol`	software.amazon.awssdk.http.Protocol

Configuration properties for ProxyConfiguration$Builder

Property	Type	Description
`aws.crt-client.proxy.host`	java.lang.String
`aws.crt-client.proxy.port`	int
`aws.crt-client.proxy.scheme`	java.lang.String
`aws.crt-client.proxy.username`	java.lang.String
`aws.crt-client.proxy.password`	java.lang.String
`aws.crt-client.proxy.use-system-property-values`	java.lang.Boolean
`aws.crt-client.proxy.use-environment-variable-values`	java.lang.Boolean
`aws.crt-client.proxy.non-proxy-hosts`	java.util.Set
`aws.crt-client.proxy.add-non-proxy-host`	java.lang.String

Configuration properties for NettyNioAsyncHttpClient$Builder

Property	Type	Description
`aws.netty-client.max-concurrency`	java.lang.Integer
`aws.netty-client.max-pending-connection-acquires`	java.lang.Integer
`aws.netty-client.read-timeout`	java.time.Duration
`aws.netty-client.write-timeout`	java.time.Duration
`aws.netty-client.connection-timeout`	java.time.Duration
`aws.netty-client.connection-acquisition-timeout`	java.time.Duration
`aws.netty-client.connection-time-to-live`	java.time.Duration
`aws.netty-client.connection-max-idle-time`	java.time.Duration
`aws.netty-client.tls-negotiation-timeout`	java.time.Duration
`aws.netty-client.use-idle-connection-reaper`	java.lang.Boolean
`aws.netty-client.protocol`	software.amazon.awssdk.http.Protocol
`aws.netty-client.protocol-negotiation`	software.amazon.awssdk.http.ProtocolNegotiation
`aws.netty-client.tcp-keep-alive`	java.lang.Boolean
`aws.netty-client.max-http2-streams`	java.lang.Integer
`aws.netty-client.use-non-blocking-dns-resolver`	java.lang.Boolean

Configuration properties for ProxyConfiguration$Builder

Property	Type	Description
`aws.netty-client.proxy.host`	java.lang.String
`aws.netty-client.proxy.port`	int
`aws.netty-client.proxy.scheme`	java.lang.String
`aws.netty-client.proxy.non-proxy-hosts`	java.util.Set
`aws.netty-client.proxy.proxy-auth-scheme`	software.amazon.awssdk.http.ProxyAuthScheme
`aws.netty-client.proxy.username`	java.lang.String
`aws.netty-client.proxy.password`	java.lang.String
`aws.netty-client.proxy.use-system-property-values`	java.lang.Boolean
`aws.netty-client.proxy.use-environment-variable-values`	java.lang.Boolean

Configuration properties for S3Configuration$Builder

Property	Type	Description
`aws.s3.accelerate-mode-enabled`	java.lang.Boolean
`aws.s3.path-style-access-enabled`	java.lang.Boolean
`aws.s3.chunked-encoding-enabled`	java.lang.Boolean
`aws.s3.expect-continue-enabled`	java.lang.Boolean
`aws.s3.expect-continue-threshold-in-bytes`	java.lang.Long
`aws.s3.use-arn-region-enabled`	java.lang.Boolean
`aws.s3.multi-region-enabled`	java.lang.Boolean
`aws.s3.profile-name`	java.lang.String

Configuration properties for AWSServiceConfigurationProperties

Property	Type	Description
`aws.services.*.endpoint-override`	java.net.URI	Provide a URI to override the endpoint with which the AWS SDK should communicate. Optional. Defaults to null .

Configuration properties for UrlConnectionHttpClient$Builder

Property	Type	Description
`aws.url-connection-client.socket-timeout`	java.time.Duration
`aws.url-connection-client.connection-timeout`	java.time.Duration
`aws.url-connection-client.proxy-configuration`	software.amazon.awssdk.http.urlconnection.ProxyConfiguration

Micronaut Aws Secretsmanager Config Properties

Configuration properties for SecretsManagerConfigurationProperties

Property	Type	Description
`aws.secretsmanager.enabled`	boolean	Default value (true).
`aws.secretsmanager.secrets`	java.util.List

Configuration properties for SecretsManagerConfigurationProperties$SecretConfiguration

Property	Type	Description
`aws.secretsmanager.secrets[*].secret-name`	java.lang.String	Sets secret name.
`aws.secretsmanager.secrets[*].prefix`	java.lang.String	Sets the group key prefix.

Micronaut Aws Service Discovery Config Properties

Configuration properties for AwsServiceDiscoveryConfiguration

Property	Type	Description
`aws.service-discovery.aws-service-id`	java.lang.String	set service ID for easier testing.
`aws.service-discovery.enabled`	boolean	enable/disabled this feature. Default value ({@value io.micronaut.discovery.DiscoveryConfiguration#DEFAULT_ENABLED}).

Configuration properties for AwsServiceDiscoveryClientConfiguration

Property	Type	Description
`aws.service-discovery.client.http-version`	HttpVersion
`aws.service-discovery.client.log-level`	LogLevel
`aws.service-discovery.client.event-loop-group`	java.lang.String
`aws.service-discovery.client.ssl-configuration`	SslConfiguration
`aws.service-discovery.client.follow-redirects`	boolean
`aws.service-discovery.client.exception-on-error-status`	boolean
`aws.service-discovery.client.decompression-enabled`	boolean
`aws.service-discovery.client.logger-name`	java.lang.String
`aws.service-discovery.client.redirect-always-filtered-headers`	java.util.Set
`aws.service-discovery.client.redirect-additional-non-preserve-body-filtered-headers`	java.util.Set
`aws.service-discovery.client.redirect-cross-origin-filtered-headers`	java.util.Set
`aws.service-discovery.client.max-redirects`	int
`aws.service-discovery.client.default-charset`	java.nio.charset.Charset
`aws.service-discovery.client.channel-options`	java.util.Map
`aws.service-discovery.client.read-timeout`	java.time.Duration
`aws.service-discovery.client.request-timeout`	java.time.Duration
`aws.service-discovery.client.read-idle-timeout`	java.time.Duration
`aws.service-discovery.client.connection-pool-idle-timeout`	java.time.Duration
`aws.service-discovery.client.connect-timeout`	java.time.Duration
`aws.service-discovery.client.connect-ttl`	java.time.Duration
`aws.service-discovery.client.shutdown-quiet-period`	java.time.Duration
`aws.service-discovery.client.shutdown-timeout`	java.time.Duration
`aws.service-discovery.client.num-of-threads`	java.lang.Integer
`aws.service-discovery.client.thread-factory`	java.lang.Class
`aws.service-discovery.client.max-content-length`	int
`aws.service-discovery.client.max-header-size`	int
`aws.service-discovery.client.max-initial-line-length`	int
`aws.service-discovery.client.max-chunk-size`	int
`aws.service-discovery.client.proxy-type`	java.net.Proxy$Type
`aws.service-discovery.client.proxy-address`	java.net.SocketAddress
`aws.service-discovery.client.proxy-username`	java.lang.String
`aws.service-discovery.client.proxy-password`	java.lang.String
`aws.service-discovery.client.proxy-selector`	java.net.ProxySelector
`aws.service-discovery.client.plaintext-mode`	HttpVersionSelection$PlaintextMode
`aws.service-discovery.client.alpn-modes`	java.util.List
`aws.service-discovery.client.allow-block-event-loop`	boolean
`aws.service-discovery.client.dns-resolution-mode`	HttpClientConfiguration$DnsResolutionMode
`aws.service-discovery.client.address-resolver-group-name`	java.lang.String
`aws.service-discovery.client.pcap-logging-path-pattern`	java.lang.String
`aws.service-discovery.client.should-use-dns`	boolean
`aws.service-discovery.client.context-path`	java.lang.String
`aws.service-discovery.client.default-zone`	java.util.List
`aws.service-discovery.client.zones`	java.util.Map
`aws.service-discovery.client.secure`	boolean
`aws.service-discovery.client.host`	java.lang.String
`aws.service-discovery.client.port`	int
`aws.service-discovery.client.namespace-id`	java.lang.String	allows you to override the namespace id for testing.
`aws.service-discovery.client.aws-service-id`	java.lang.String	set service id for easier testing.
`aws.service-discovery.client.other-zones`	java.util.List

Configuration properties for AwsServiceDiscoveryRegistrationConfiguration

Property	Type	Description
`aws.service-discovery.registration.ip-addr`	java.lang.String
`aws.service-discovery.registration.prefer-ip-address`	boolean
`aws.service-discovery.registration.timeout`	java.time.Duration
`aws.service-discovery.registration.fail-fast`	boolean
`aws.service-discovery.registration.deregister`	boolean
`aws.service-discovery.registration.enabled`	boolean
`aws.service-discovery.registration.retry-count`	int
`aws.service-discovery.registration.retry-delay`	java.time.Duration
`aws.service-discovery.registration.health-path`	java.lang.String
`aws.service-discovery.registration.aws-service-id`	java.lang.String	Setting for service id to make easier testing.

Micronaut Function Client Aws Config Properties

Configuration properties for AWSLambdaAsyncClientBuilder

Property	Type	Description
`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
`aws.lambda.executor-factory`	com.amazonaws.client.builder.ExecutorFactory

Configuration properties for AWSLambdaAsyncClientBuilder

Property	Type	Description
`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
`aws.lambda.executor-factory`	com.amazonaws.client.builder.ExecutorFactory

Configuration properties for InvokeRequest

Property	Type	Description
`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
`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

Configuration properties for InvokeRequest

Property	Type	Description
`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
`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

Micronaut Function Client Aws V2 Config Properties

Configuration properties for AwsInvokeRequestDefinition

Property	Type	Description
`aws.lambda.functions.*.function-name`	java.lang.String	The name or ARN of the Lambda function, version, or alias.
`aws.lambda.functions.*.qualifier`	java.lang.String	{@see software.amazon.awssdk.services.lambda.model.InvokeRequest#qualifier}.
`aws.lambda.functions.*.client-context`	java.lang.String	Up to 3,583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.