diff --git a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonServicesClientsProcessor.java b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonServicesClientsProcessor.java index 2dfbd8df4..2e947f1a8 100644 --- a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonServicesClientsProcessor.java +++ b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonServicesClientsProcessor.java @@ -48,6 +48,9 @@ void runtimeInitialize(BuildProducer producer) // FullJitterBackoffStrategy uses j.u.Ramdom, so needs to be runtime-initialized producer.produce( new RuntimeInitializedClassBuildItem("software.amazon.awssdk.core.retry.backoff.FullJitterBackoffStrategy")); + // CachedSupplier uses j.u.Ramdom, so needs to be runtime-initialized + producer.produce( + new RuntimeInitializedClassBuildItem("software.amazon.awssdk.utils.cache.CachedSupplier")); } @BuildStep diff --git a/docs/modules/ROOT/pages/includes/attributes.adoc b/docs/modules/ROOT/pages/includes/attributes.adoc index 1bbbd2296..5ee478402 100644 --- a/docs/modules/ROOT/pages/includes/attributes.adoc +++ b/docs/modules/ROOT/pages/includes/attributes.adoc @@ -1,4 +1,4 @@ -:quarkus-version: 2.10.0.Final +:quarkus-version: 2.11.0.Final :quarkus-amazon-services-version: 1.1.2 :maven-version: 3.8.1+ diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc index 4855bb2d9..aa3f251be 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-cognitouserpools [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -39,6 +45,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.endpoint-overrid -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -51,8 +59,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.api-call-timeout The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -62,8 +72,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.api-call-attempt -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -88,6 +100,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_REGION+++` --|Region | @@ -120,6 +134,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -136,6 +152,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -146,6 +164,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -160,6 +180,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -169,6 +191,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -178,6 +202,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -193,6 +219,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -208,6 +236,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -218,8 +248,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -228,6 +260,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -237,6 +271,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials. [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -251,8 +287,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.conn [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -261,8 +299,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.sock [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -279,6 +319,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -289,6 +331,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -299,6 +343,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -308,6 +354,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls- [.description] -- Key store password + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -325,6 +373,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -335,6 +385,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -345,6 +397,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -354,6 +408,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls- [.description] -- Key store password + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -368,8 +424,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -378,8 +436,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -388,8 +448,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -399,6 +461,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -408,6 +472,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -418,6 +484,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -427,6 +495,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -437,6 +507,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -447,6 +519,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -456,6 +530,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -465,6 +541,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -474,6 +552,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -483,6 +563,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -492,6 +574,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apac [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -507,6 +591,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.max -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -517,6 +603,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.max -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -527,8 +615,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.rea -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -538,8 +628,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.wri -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -548,8 +640,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.con [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -558,8 +652,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.con [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -568,8 +664,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.con [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -579,8 +677,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.con -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -590,6 +690,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.use -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -599,6 +701,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.pro [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -610,6 +714,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.ssl -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -621,6 +727,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.htt -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -631,6 +739,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.htt -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -641,8 +751,10 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.htt -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -651,6 +763,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.pro [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -661,6 +775,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.pro -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -671,6 +787,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.pro [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -688,6 +806,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -698,6 +818,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -708,6 +830,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -717,6 +841,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls [.description] -- Key store password + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -734,6 +860,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -744,6 +872,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -754,6 +884,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -763,6 +895,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls [.description] -- Key store password + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -772,6 +906,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.eve [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -782,6 +918,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.eve -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -793,6 +931,8 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.eve The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -803,13 +943,15 @@ a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.adv -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc index 37d7b44aa..415431a88 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-dynamodb [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus.dynamod -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_DYNAMODB_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus.dynamod [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -33,6 +39,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.enable-endpoint-discovery]]`link:# [.description] -- Enable DynamoDB service endpoint discovery. + +Environment variable: `+++QUARKUS_DYNAMODB_ENABLE_ENDPOINT_DISCOVERY+++` --|boolean |`false` @@ -48,6 +56,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.endpoint-override]]`link:#quarkus- -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_DYNAMODB_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -60,8 +70,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.api-call-timeout]]`link:#quarkus-a The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_DYNAMODB_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -71,8 +83,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.api-call-attempt-timeout]]`link:#q -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_DYNAMODB_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -97,6 +111,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_REGION+++` --|Region | @@ -129,6 +145,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -145,6 +163,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.default-provider.a -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -155,6 +175,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.default-provider.r -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -169,6 +191,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.static-provider.ac [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -178,6 +202,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.static-provider.se [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -187,6 +213,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.static-provider.se [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -202,6 +230,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.profile-provider.p -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -217,6 +247,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.a -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -227,8 +259,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.c -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -237,6 +271,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.p [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -246,6 +282,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.c [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -260,8 +298,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.connection-timeout]]`l [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -270,8 +310,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.socket-timeout]]`link: [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -288,6 +330,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -298,6 +342,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provi [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -308,6 +354,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provi -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -317,6 +365,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provi [.description] -- Key store password + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -334,6 +384,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -344,6 +396,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-pro [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -354,6 +408,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-pro -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -363,6 +419,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-pro [.description] -- Key store password + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -377,8 +435,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.connection-acqu [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -387,8 +447,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.connection-max- [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -397,8 +459,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.connection-time [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -408,6 +472,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.max-connections -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -417,6 +483,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.expect-continue [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -427,6 +495,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.use-idle-connec -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -436,6 +506,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.enabled]] [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -446,6 +518,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.endpoint] -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -456,6 +530,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.username] [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -465,6 +541,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.password] [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -474,6 +552,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.ntlm-doma [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -483,6 +563,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.ntlm-work [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -492,6 +574,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.preemptiv [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -501,6 +585,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.non-proxy [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -516,6 +602,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.max-concurrency]]`lin -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -526,6 +614,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.max-pending-connectio -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -536,8 +626,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.read-timeout]]`link:# -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -547,8 +639,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.write-timeout]]`link: -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -557,8 +651,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-timeout]]` [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -567,8 +663,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-acquisitio [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -577,8 +675,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-time-to-li [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -588,8 +688,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-max-idle-t -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -599,6 +701,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.use-idle-connection-r -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -608,6 +712,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.protocol]]`link:#quar [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -619,6 +725,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.ssl-provider]]`link:# -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -630,6 +738,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.http2.max-streams]]`l -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -640,6 +750,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.http2.initial-window- -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -650,8 +762,10 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.http2.health-check-pi -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -660,6 +774,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.proxy.enabled]]`link: [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -670,6 +786,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.proxy.endpoint]]`link -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -680,6 +798,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.proxy.non-proxy-hosts [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -697,6 +817,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -707,6 +829,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-prov [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -717,6 +841,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-prov -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -726,6 +852,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-prov [.description] -- Key store password + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -743,6 +871,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -753,6 +883,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-pr [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -763,6 +895,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-pr -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -772,6 +906,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-pr [.description] -- Key store password + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -781,6 +917,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.event-loop.override]] [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -791,6 +929,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.event-loop.number-of- -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -802,6 +942,8 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.event-loop.thread-nam The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -812,13 +954,15 @@ a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.advanced.use-future-c -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc index 43ec35110..80b40605f 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-iam [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus.iam.intercep -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_IAM_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus.iam.sync-cli [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -39,6 +45,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.endpoint-override]]`link:#quarkus-amazon-iam -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_IAM_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -51,8 +59,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.api-call-timeout]]`link:#quarkus-amazon-iam_ The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_IAM_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -62,8 +72,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.api-call-attempt-timeout]]`link:#quarkus-ama -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_IAM_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -88,6 +100,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_IAM_AWS_REGION+++` --|Region | @@ -120,6 +134,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -136,6 +152,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.default-provider.async-crede -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -146,6 +164,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.default-provider.reuse-last- -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -160,6 +180,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.static-provider.access-key-i [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -169,6 +191,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.static-provider.secret-acces [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -178,6 +202,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.static-provider.session-toke [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -193,6 +219,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.profile-provider.profile-nam -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -208,6 +236,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.async-crede -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -218,8 +248,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.credential- -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -228,6 +260,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.process-out [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -237,6 +271,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.command]]`l [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -251,8 +287,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.connection-timeout]]`link:#quark [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -261,8 +299,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.socket-timeout]]`link:#quarkus-a [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -279,6 +319,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -289,6 +331,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.file-s [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -299,6 +343,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.file-s -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -308,6 +354,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.file-s [.description] -- Key store password + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -325,6 +373,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -335,6 +385,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.file [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -345,6 +397,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.file -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -354,6 +408,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.file [.description] -- Key store password + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -368,8 +424,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.connection-acquisition-ti [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -378,8 +436,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.connection-max-idle-time] [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -388,8 +448,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.connection-time-to-live]] [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -399,6 +461,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.max-connections]]`link:#q -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -408,6 +472,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.expect-continue-enabled]] [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -418,6 +484,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.use-idle-connection-reape -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -427,6 +495,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.enabled]]`link:#qua [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -437,6 +507,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.endpoint]]`link:#qu -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -447,6 +519,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.username]]`link:#qu [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -456,6 +530,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.password]]`link:#qu [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -465,6 +541,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.ntlm-domain]]`link: [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -474,6 +552,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.ntlm-workstation]]` [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -483,6 +563,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.preemptive-basic-au [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -492,6 +574,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.non-proxy-hosts]]`l [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -507,6 +591,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.max-concurrency]]`link:#quarkus -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -517,6 +603,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.max-pending-connection-acquires -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -527,8 +615,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.read-timeout]]`link:#quarkus-am -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -538,8 +628,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.write-timeout]]`link:#quarkus-a -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -548,8 +640,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.connection-timeout]]`link:#quar [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -558,8 +652,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.connection-acquisition-timeout] [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -568,8 +664,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.connection-time-to-live]]`link: [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -579,8 +677,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.connection-max-idle-time]]`link -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -590,6 +690,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.use-idle-connection-reaper]]`li -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -599,6 +701,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.protocol]]`link:#quarkus-amazon [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -610,6 +714,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.ssl-provider]]`link:#quarkus-am -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -621,6 +727,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.http2.max-streams]]`link:#quark -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -631,6 +739,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.http2.initial-window-size]]`lin -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -641,8 +751,10 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.http2.health-check-ping-period] -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -651,6 +763,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.proxy.enabled]]`link:#quarkus-a [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -661,6 +775,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.proxy.endpoint]]`link:#quarkus- -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -671,6 +787,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.proxy.non-proxy-hosts]]`link:#q [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -688,6 +806,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -698,6 +818,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.file- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -708,6 +830,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.file- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -717,6 +841,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.file- [.description] -- Key store password + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -734,6 +860,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -744,6 +872,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.fil [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -754,6 +884,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.fil -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -763,6 +895,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.fil [.description] -- Key store password + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -772,6 +906,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.event-loop.override]]`link:#qua [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -782,6 +918,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.event-loop.number-of-threads]]` -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -793,6 +931,8 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.event-loop.thread-name-prefix]] The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -803,13 +943,15 @@ a| [[quarkus-amazon-iam_quarkus.iam.async-client.advanced.use-future-completion- -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc index 1973ab56b..3f91588a6 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-kms [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus.kms.intercep -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_KMS_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus.kms.sync-cli [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -39,6 +45,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.endpoint-override]]`link:#quarkus-amazon-kms -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_KMS_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -51,8 +59,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.api-call-timeout]]`link:#quarkus-amazon-kms_ The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_KMS_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -62,8 +72,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.api-call-attempt-timeout]]`link:#quarkus-ama -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_KMS_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -88,6 +100,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_KMS_AWS_REGION+++` --|Region | @@ -120,6 +134,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -136,6 +152,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.default-provider.async-crede -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -146,6 +164,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.default-provider.reuse-last- -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -160,6 +180,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.static-provider.access-key-i [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -169,6 +191,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.static-provider.secret-acces [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -178,6 +202,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.static-provider.session-toke [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -193,6 +219,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.profile-provider.profile-nam -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -208,6 +236,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.async-crede -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -218,8 +248,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.credential- -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -228,6 +260,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.process-out [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -237,6 +271,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.command]]`l [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -251,8 +287,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.connection-timeout]]`link:#quark [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -261,8 +299,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.socket-timeout]]`link:#quarkus-a [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -279,6 +319,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -289,6 +331,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.file-s [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -299,6 +343,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.file-s -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -308,6 +354,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.file-s [.description] -- Key store password + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -325,6 +373,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -335,6 +385,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.file [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -345,6 +397,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.file -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -354,6 +408,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.file [.description] -- Key store password + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -368,8 +424,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.connection-acquisition-ti [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -378,8 +436,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.connection-max-idle-time] [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -388,8 +448,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.connection-time-to-live]] [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -399,6 +461,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.max-connections]]`link:#q -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -408,6 +472,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.expect-continue-enabled]] [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -418,6 +484,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.use-idle-connection-reape -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -427,6 +495,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.enabled]]`link:#qua [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -437,6 +507,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.endpoint]]`link:#qu -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -447,6 +519,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.username]]`link:#qu [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -456,6 +530,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.password]]`link:#qu [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -465,6 +541,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.ntlm-domain]]`link: [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -474,6 +552,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.ntlm-workstation]]` [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -483,6 +563,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.preemptive-basic-au [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -492,6 +574,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.non-proxy-hosts]]`l [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -507,6 +591,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.max-concurrency]]`link:#quarkus -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -517,6 +603,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.max-pending-connection-acquires -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -527,8 +615,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.read-timeout]]`link:#quarkus-am -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -538,8 +628,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.write-timeout]]`link:#quarkus-a -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -548,8 +640,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.connection-timeout]]`link:#quar [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -558,8 +652,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.connection-acquisition-timeout] [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -568,8 +664,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.connection-time-to-live]]`link: [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -579,8 +677,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.connection-max-idle-time]]`link -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -590,6 +690,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.use-idle-connection-reaper]]`li -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -599,6 +701,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.protocol]]`link:#quarkus-amazon [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -610,6 +714,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.ssl-provider]]`link:#quarkus-am -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -621,6 +727,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.http2.max-streams]]`link:#quark -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -631,6 +739,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.http2.initial-window-size]]`lin -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -641,8 +751,10 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.http2.health-check-ping-period] -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -651,6 +763,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.proxy.enabled]]`link:#quarkus-a [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -661,6 +775,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.proxy.endpoint]]`link:#quarkus- -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -671,6 +787,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.proxy.non-proxy-hosts]]`link:#q [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -688,6 +806,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -698,6 +818,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.file- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -708,6 +830,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.file- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -717,6 +841,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.file- [.description] -- Key store password + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -734,6 +860,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -744,6 +872,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.fil [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -754,6 +884,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.fil -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -763,6 +895,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.fil [.description] -- Key store password + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -772,6 +906,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.event-loop.override]]`link:#qua [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -782,6 +918,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.event-loop.number-of-threads]]` -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -793,6 +931,8 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.event-loop.thread-name-prefix]] The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -803,13 +943,15 @@ a| [[quarkus-amazon-kms_quarkus.kms.async-client.advanced.use-future-completion- -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc index 649a8bd72..85ec088f9 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-s3 [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.intercepto -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_S3_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.sync-clien [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -34,6 +40,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.accelerate-mode]]`link:#quarkus-amazon-s3_quar -- Enable using the accelerate endpoint when accessing S3. Accelerate endpoints allow faster transfer of objects by using Amazon CloudFront's globally distributed edge locations. + +Environment variable: `+++QUARKUS_S3_ACCELERATE_MODE+++` --|boolean |`false` @@ -43,6 +51,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.checksum-validation]]`link:#quarkus-amazon-s3_ [.description] -- Enable doing a validation of the checksum of an object stored in S3. + +Environment variable: `+++QUARKUS_S3_CHECKSUM_VALIDATION+++` --|boolean |`true` @@ -52,6 +62,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.chunked-encoding]]`link:#quarkus-amazon-s3_qua [.description] -- Enable using chunked encoding when signing the request payload for `software.amazon.awssdk.services.s3.model.PutObjectRequest` and `software.amazon.awssdk.services.s3.model.UploadPartRequest`. + +Environment variable: `+++QUARKUS_S3_CHUNKED_ENCODING+++` --|boolean |`true` @@ -61,6 +73,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.dualstack]]`link:#quarkus-amazon-s3_quarkus.s3 [.description] -- Enable dualstack mode for accessing S3. If you want to use IPv6 when accessing S3, dualstack must be enabled. + +Environment variable: `+++QUARKUS_S3_DUALSTACK+++` --|boolean |`false` @@ -70,6 +84,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.path-style-access]]`link:#quarkus-amazon-s3_qu [.description] -- Enable using path style access for accessing S3 objects instead of DNS style access. DNS style access is preferred as it will result in better load balancing when accessing S3. + +Environment variable: `+++QUARKUS_S3_PATH_STYLE_ACCESS+++` --|boolean |`false` @@ -79,6 +95,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.use-arn-region-enabled]]`link:#quarkus-amazon- [.description] -- Enable cross-region call to the region specified in the S3 resource ARN different than the region the client was configured with. If this flag is not set to 'true', the cross-region call will throw an exception. + +Environment variable: `+++QUARKUS_S3_USE_ARN_REGION_ENABLED+++` --|boolean |`false` @@ -89,6 +107,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.profile-name]]`link:#quarkus-amazon-s3_quarkus -- Define the profile name that should be consulted to determine the default value of `use-arn-region-enabled`. This is not used, if the `use-arn-region-enabled` is configured to 'true'. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_S3_PROFILE_NAME+++` --|string | @@ -104,6 +124,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.endpoint-override]]`link:#quarkus-amazon-s3_qu -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_S3_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -116,8 +138,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.api-call-timeout]]`link:#quarkus-amazon-s3_qua The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_S3_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -127,8 +151,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.api-call-attempt-timeout]]`link:#quarkus-amazo -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_S3_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -153,6 +179,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_S3_AWS_REGION+++` --|Region | @@ -185,6 +213,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -201,6 +231,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.default-provider.async-credent -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -211,6 +243,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.default-provider.reuse-last-pr -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -225,6 +259,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.static-provider.access-key-id] [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -234,6 +270,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.static-provider.secret-access- [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -243,6 +281,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.static-provider.session-token] [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -258,6 +298,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.profile-provider.profile-name] -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -273,6 +315,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.async-credent -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -283,8 +327,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.credential-re -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -293,6 +339,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.process-outpu [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -302,6 +350,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.command]]`lin [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -316,8 +366,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.connection-timeout]]`link:#quarkus [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -326,8 +378,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.socket-timeout]]`link:#quarkus-ama [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -344,6 +398,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -354,6 +410,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.file-sto [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -364,6 +422,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.file-sto -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -373,6 +433,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.file-sto [.description] -- Key store password + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -390,6 +452,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -400,6 +464,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.file-s [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -410,6 +476,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.file-s -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -419,6 +487,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.file-s [.description] -- Key store password + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -433,8 +503,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.connection-acquisition-time [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -443,8 +515,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.connection-max-idle-time]]` [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -453,8 +527,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.connection-time-to-live]]`l [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -464,6 +540,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.max-connections]]`link:#qua -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -473,6 +551,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.expect-continue-enabled]]`l [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -483,6 +563,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.use-idle-connection-reaper] -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -492,6 +574,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.enabled]]`link:#quark [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -502,6 +586,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.endpoint]]`link:#quar -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -512,6 +598,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.username]]`link:#quar [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -521,6 +609,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.password]]`link:#quar [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -530,6 +620,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.ntlm-domain]]`link:#q [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -539,6 +631,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.ntlm-workstation]]`li [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -548,6 +642,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.preemptive-basic-auth [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -557,6 +653,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.non-proxy-hosts]]`lin [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -572,6 +670,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.max-concurrency]]`link:#quarkus-a -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -582,6 +682,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.max-pending-connection-acquires]] -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -592,8 +694,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.read-timeout]]`link:#quarkus-amaz -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -603,8 +707,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.write-timeout]]`link:#quarkus-ama -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -613,8 +719,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.connection-timeout]]`link:#quarku [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -623,8 +731,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.connection-acquisition-timeout]]` [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -633,8 +743,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.connection-time-to-live]]`link:#q [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -644,8 +756,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.connection-max-idle-time]]`link:# -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -655,6 +769,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.use-idle-connection-reaper]]`link -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -664,6 +780,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.protocol]]`link:#quarkus-amazon-s [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -675,6 +793,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.ssl-provider]]`link:#quarkus-amaz -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -686,6 +806,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.http2.max-streams]]`link:#quarkus -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -696,6 +818,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.http2.initial-window-size]]`link: -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -706,8 +830,10 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.http2.health-check-ping-period]]` -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -716,6 +842,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.proxy.enabled]]`link:#quarkus-ama [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -726,6 +854,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.proxy.endpoint]]`link:#quarkus-am -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -736,6 +866,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.proxy.non-proxy-hosts]]`link:#qua [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -753,6 +885,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -763,6 +897,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.file-st [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -773,6 +909,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.file-st -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -782,6 +920,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.file-st [.description] -- Key store password + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -799,6 +939,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -809,6 +951,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.file- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -819,6 +963,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.file- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -828,6 +974,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.file- [.description] -- Key store password + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -837,6 +985,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.event-loop.override]]`link:#quark [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -847,6 +997,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.event-loop.number-of-threads]]`li -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -858,6 +1010,8 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.event-loop.thread-name-prefix]]`l The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -868,13 +1022,15 @@ a| [[quarkus-amazon-s3_quarkus.s3.async-client.advanced.use-future-completion-th -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc index 7710d608c..d8c5b78c1 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-secretsmanager [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus.s -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus.s [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -39,6 +45,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.endpoint-override]]`li -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -51,8 +59,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.api-call-timeout]]`lin The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -62,8 +72,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.api-call-attempt-timeo -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -88,6 +100,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_REGION+++` --|Region | @@ -120,6 +134,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -136,6 +152,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.defaul -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -146,6 +164,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.defaul -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -160,6 +180,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.static [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -169,6 +191,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.static [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -178,6 +202,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.static [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -193,6 +219,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.profil -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -208,6 +236,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.proces -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -218,8 +248,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.proces -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -228,6 +260,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.proces [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -237,6 +271,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.proces [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -251,8 +287,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.connection [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -261,8 +299,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.socket-tim [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -279,6 +319,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -289,6 +331,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-ma [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -299,6 +343,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-ma -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -308,6 +354,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-ma [.description] -- Key store password + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -325,6 +373,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -335,6 +385,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -345,6 +397,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -354,6 +408,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust- [.description] -- Key store password + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -368,8 +424,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.con [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -378,8 +436,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.con [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -388,8 +448,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.con [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -399,6 +461,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.max -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -408,6 +472,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.exp [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -418,6 +484,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.use -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -427,6 +495,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.pro [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -437,6 +507,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.pro -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -447,6 +519,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.pro [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -456,6 +530,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.pro [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -465,6 +541,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.pro [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -474,6 +552,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.pro [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -483,6 +563,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.pro [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -492,6 +574,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.pro [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -507,6 +591,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.max-concu -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -517,6 +603,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.max-pendi -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -527,8 +615,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.read-time -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -538,8 +628,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.write-tim -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -548,8 +640,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connectio [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -558,8 +652,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connectio [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -568,8 +664,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connectio [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -579,8 +677,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connectio -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -590,6 +690,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.use-idle- -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -599,6 +701,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.protocol] [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -610,6 +714,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.ssl-provi -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -621,6 +727,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.http2.max -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -631,6 +739,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.http2.ini -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -641,8 +751,10 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.http2.hea -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -651,6 +763,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.proxy.ena [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -661,6 +775,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.proxy.end -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -671,6 +787,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.proxy.non [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -688,6 +806,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -698,6 +818,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-m [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -708,6 +830,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-m -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -717,6 +841,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-m [.description] -- Key store password + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -734,6 +860,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -744,6 +872,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -754,6 +884,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -763,6 +895,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust [.description] -- Key store password + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -772,6 +906,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.event-loo [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -782,6 +918,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.event-loo -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -793,6 +931,8 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.event-loo The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -803,13 +943,15 @@ a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.advanced. -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc index 41a0c1879..d672102d3 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-ses [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus.ses.intercep -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_SES_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus.ses.sync-cli [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -39,6 +45,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.endpoint-override]]`link:#quarkus-amazon-ses -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_SES_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -51,8 +59,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.api-call-timeout]]`link:#quarkus-amazon-ses_ The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SES_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -62,8 +72,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.api-call-attempt-timeout]]`link:#quarkus-ama -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SES_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -88,6 +100,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_SES_AWS_REGION+++` --|Region | @@ -120,6 +134,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -136,6 +152,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.default-provider.async-crede -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -146,6 +164,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.default-provider.reuse-last- -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -160,6 +180,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.static-provider.access-key-i [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -169,6 +191,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.static-provider.secret-acces [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -178,6 +202,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.static-provider.session-toke [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -193,6 +219,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.profile-provider.profile-nam -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -208,6 +236,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.async-crede -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -218,8 +248,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.credential- -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -228,6 +260,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.process-out [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -237,6 +271,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.command]]`l [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -251,8 +287,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.connection-timeout]]`link:#quark [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -261,8 +299,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.socket-timeout]]`link:#quarkus-a [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -279,6 +319,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -289,6 +331,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.file-s [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -299,6 +343,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.file-s -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -308,6 +354,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.file-s [.description] -- Key store password + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -325,6 +373,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -335,6 +385,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.file [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -345,6 +397,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.file -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -354,6 +408,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.file [.description] -- Key store password + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -368,8 +424,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.connection-acquisition-ti [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -378,8 +436,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.connection-max-idle-time] [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -388,8 +448,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.connection-time-to-live]] [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -399,6 +461,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.max-connections]]`link:#q -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -408,6 +472,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.expect-continue-enabled]] [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -418,6 +484,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.use-idle-connection-reape -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -427,6 +495,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.enabled]]`link:#qua [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -437,6 +507,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.endpoint]]`link:#qu -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -447,6 +519,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.username]]`link:#qu [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -456,6 +530,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.password]]`link:#qu [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -465,6 +541,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.ntlm-domain]]`link: [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -474,6 +552,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.ntlm-workstation]]` [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -483,6 +563,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.preemptive-basic-au [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -492,6 +574,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.non-proxy-hosts]]`l [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -507,6 +591,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.max-concurrency]]`link:#quarkus -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -517,6 +603,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.max-pending-connection-acquires -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -527,8 +615,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.read-timeout]]`link:#quarkus-am -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -538,8 +628,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.write-timeout]]`link:#quarkus-a -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -548,8 +640,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.connection-timeout]]`link:#quar [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -558,8 +652,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.connection-acquisition-timeout] [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -568,8 +664,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.connection-time-to-live]]`link: [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -579,8 +677,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.connection-max-idle-time]]`link -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -590,6 +690,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.use-idle-connection-reaper]]`li -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -599,6 +701,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.protocol]]`link:#quarkus-amazon [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -610,6 +714,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.ssl-provider]]`link:#quarkus-am -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -621,6 +727,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.http2.max-streams]]`link:#quark -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -631,6 +739,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.http2.initial-window-size]]`lin -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -641,8 +751,10 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.http2.health-check-ping-period] -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -651,6 +763,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.proxy.enabled]]`link:#quarkus-a [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -661,6 +775,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.proxy.endpoint]]`link:#quarkus- -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -671,6 +787,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.proxy.non-proxy-hosts]]`link:#q [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -688,6 +806,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -698,6 +818,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.file- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -708,6 +830,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.file- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -717,6 +841,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.file- [.description] -- Key store password + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -734,6 +860,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -744,6 +872,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.fil [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -754,6 +884,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.fil -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -763,6 +895,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.fil [.description] -- Key store password + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -772,6 +906,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.event-loop.override]]`link:#qua [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -782,6 +918,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.event-loop.number-of-threads]]` -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -793,6 +931,8 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.event-loop.thread-name-prefix]] The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -803,13 +943,15 @@ a| [[quarkus-amazon-ses_quarkus.ses.async-client.advanced.use-future-completion- -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc index b7a3c0326..87508c31a 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-sns [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus.sns.intercep -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_SNS_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus.sns.sync-cli [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -39,6 +45,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.endpoint-override]]`link:#quarkus-amazon-sns -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_SNS_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -51,8 +59,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.api-call-timeout]]`link:#quarkus-amazon-sns_ The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SNS_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -62,8 +72,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.api-call-attempt-timeout]]`link:#quarkus-ama -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SNS_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -88,6 +100,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_SNS_AWS_REGION+++` --|Region | @@ -120,6 +134,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -136,6 +152,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.default-provider.async-crede -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -146,6 +164,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.default-provider.reuse-last- -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -160,6 +180,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.static-provider.access-key-i [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -169,6 +191,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.static-provider.secret-acces [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -178,6 +202,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.static-provider.session-toke [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -193,6 +219,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.profile-provider.profile-nam -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -208,6 +236,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.async-crede -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -218,8 +248,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.credential- -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -228,6 +260,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.process-out [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -237,6 +271,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.command]]`l [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -251,8 +287,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.connection-timeout]]`link:#quark [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -261,8 +299,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.socket-timeout]]`link:#quarkus-a [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -279,6 +319,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -289,6 +331,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.file-s [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -299,6 +343,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.file-s -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -308,6 +354,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.file-s [.description] -- Key store password + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -325,6 +373,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -335,6 +385,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.file [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -345,6 +397,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.file -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -354,6 +408,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.file [.description] -- Key store password + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -368,8 +424,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.connection-acquisition-ti [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -378,8 +436,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.connection-max-idle-time] [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -388,8 +448,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.connection-time-to-live]] [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -399,6 +461,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.max-connections]]`link:#q -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -408,6 +472,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.expect-continue-enabled]] [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -418,6 +484,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.use-idle-connection-reape -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -427,6 +495,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.enabled]]`link:#qua [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -437,6 +507,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.endpoint]]`link:#qu -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -447,6 +519,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.username]]`link:#qu [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -456,6 +530,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.password]]`link:#qu [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -465,6 +541,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.ntlm-domain]]`link: [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -474,6 +552,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.ntlm-workstation]]` [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -483,6 +563,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.preemptive-basic-au [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -492,6 +574,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.non-proxy-hosts]]`l [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -507,6 +591,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.max-concurrency]]`link:#quarkus -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -517,6 +603,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.max-pending-connection-acquires -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -527,8 +615,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.read-timeout]]`link:#quarkus-am -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -538,8 +628,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.write-timeout]]`link:#quarkus-a -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -548,8 +640,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.connection-timeout]]`link:#quar [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -558,8 +652,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.connection-acquisition-timeout] [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -568,8 +664,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.connection-time-to-live]]`link: [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -579,8 +677,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.connection-max-idle-time]]`link -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -590,6 +690,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.use-idle-connection-reaper]]`li -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -599,6 +701,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.protocol]]`link:#quarkus-amazon [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -610,6 +714,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.ssl-provider]]`link:#quarkus-am -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -621,6 +727,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.http2.max-streams]]`link:#quark -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -631,6 +739,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.http2.initial-window-size]]`lin -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -641,8 +751,10 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.http2.health-check-ping-period] -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -651,6 +763,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.proxy.enabled]]`link:#quarkus-a [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -661,6 +775,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.proxy.endpoint]]`link:#quarkus- -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -671,6 +787,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.proxy.non-proxy-hosts]]`link:#q [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -688,6 +806,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -698,6 +818,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.file- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -708,6 +830,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.file- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -717,6 +841,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.file- [.description] -- Key store password + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -734,6 +860,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -744,6 +872,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.fil [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -754,6 +884,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.fil -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -763,6 +895,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.fil [.description] -- Key store password + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -772,6 +906,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.event-loop.override]]`link:#qua [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -782,6 +918,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.event-loop.number-of-threads]]` -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -793,6 +931,8 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.event-loop.thread-name-prefix]] The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -803,13 +943,15 @@ a| [[quarkus-amazon-sns_quarkus.sns.async-client.advanced.use-future-completion- -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc index f284350d5..ab9a34026 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-sqs [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.intercep -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_SQS_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.sync-cli [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -39,6 +45,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.endpoint-override]]`link:#quarkus-amazon-sqs -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_SQS_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -51,8 +59,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.api-call-timeout]]`link:#quarkus-amazon-sqs_ The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SQS_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -62,8 +72,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.api-call-attempt-timeout]]`link:#quarkus-ama -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SQS_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -88,6 +100,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_SQS_AWS_REGION+++` --|Region | @@ -120,6 +134,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -136,6 +152,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.default-provider.async-crede -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -146,6 +164,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.default-provider.reuse-last- -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -160,6 +180,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.static-provider.access-key-i [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -169,6 +191,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.static-provider.secret-acces [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -178,6 +202,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.static-provider.session-toke [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -193,6 +219,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.profile-provider.profile-nam -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -208,6 +236,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.async-crede -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -218,8 +248,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.credential- -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -228,6 +260,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.process-out [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -237,6 +271,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.command]]`l [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -251,8 +287,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.connection-timeout]]`link:#quark [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -261,8 +299,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.socket-timeout]]`link:#quarkus-a [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -279,6 +319,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -289,6 +331,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.file-s [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -299,6 +343,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.file-s -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -308,6 +354,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.file-s [.description] -- Key store password + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -325,6 +373,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -335,6 +385,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.file [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -345,6 +397,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.file -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -354,6 +408,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.file [.description] -- Key store password + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -368,8 +424,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.connection-acquisition-ti [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -378,8 +436,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.connection-max-idle-time] [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -388,8 +448,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.connection-time-to-live]] [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -399,6 +461,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.max-connections]]`link:#q -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -408,6 +472,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.expect-continue-enabled]] [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -418,6 +484,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.use-idle-connection-reape -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -427,6 +495,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.enabled]]`link:#qua [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -437,6 +507,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.endpoint]]`link:#qu -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -447,6 +519,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.username]]`link:#qu [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -456,6 +530,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.password]]`link:#qu [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -465,6 +541,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.ntlm-domain]]`link: [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -474,6 +552,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.ntlm-workstation]]` [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -483,6 +563,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.preemptive-basic-au [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -492,6 +574,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.non-proxy-hosts]]`l [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -507,6 +591,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.max-concurrency]]`link:#quarkus -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -517,6 +603,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.max-pending-connection-acquires -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -527,8 +615,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.read-timeout]]`link:#quarkus-am -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -538,8 +628,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.write-timeout]]`link:#quarkus-a -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -548,8 +640,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.connection-timeout]]`link:#quar [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -558,8 +652,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.connection-acquisition-timeout] [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -568,8 +664,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.connection-time-to-live]]`link: [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -579,8 +677,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.connection-max-idle-time]]`link -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -590,6 +690,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.use-idle-connection-reaper]]`li -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -599,6 +701,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.protocol]]`link:#quarkus-amazon [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -610,6 +714,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.ssl-provider]]`link:#quarkus-am -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -621,6 +727,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.http2.max-streams]]`link:#quark -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -631,6 +739,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.http2.initial-window-size]]`lin -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -641,8 +751,10 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.http2.health-check-ping-period] -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -651,6 +763,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.proxy.enabled]]`link:#quarkus-a [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -661,6 +775,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.proxy.endpoint]]`link:#quarkus- -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -671,6 +787,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.proxy.non-proxy-hosts]]`link:#q [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -688,6 +806,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -698,6 +818,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.file- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -708,6 +830,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.file- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -717,6 +841,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.file- [.description] -- Key store password + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -734,6 +860,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -744,6 +872,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.fil [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -754,6 +884,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.fil -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -763,6 +895,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.fil [.description] -- Key store password + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -772,6 +906,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.event-loop.override]]`link:#qua [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -782,6 +918,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.event-loop.number-of-threads]]` -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -793,6 +931,8 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.event-loop.thread-name-prefix]] The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -803,13 +943,15 @@ a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.advanced.use-future-completion- -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc index fefef8e75..6f4625bb6 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc @@ -1,3 +1,5 @@ + +:summaryTableId: quarkus-amazon-ssm [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] @@ -14,6 +16,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus.ssm.intercep -- List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK. The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. + +Environment variable: `+++QUARKUS_SSM_INTERCEPTORS+++` --|list of string | @@ -23,6 +27,8 @@ a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus.ssm.sync-cli [.description] -- Type of the sync HTTP client implementation + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TYPE+++` -- a| `url`, `apache` |`url` @@ -39,6 +45,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.endpoint-override]]`link:#quarkus-amazon-ssm -- The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + +Environment variable: `+++QUARKUS_SSM_ENDPOINT_OVERRIDE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -51,8 +59,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.api-call-timeout]]`link:#quarkus-amazon-ssm_ The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SSM_API_CALL_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -62,8 +72,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.api-call-attempt-timeout]]`link:#quarkus-ama -- The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. + +Environment variable: `+++QUARKUS_SSM_API_CALL_ATTEMPT_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -88,6 +100,8 @@ If not set, region is retrieved via the default providers chain in the following * Instance profile file See `software.amazon.awssdk.regions.Region` for available regions. + +Environment variable: `+++QUARKUS_SSM_AWS_REGION+++` --|Region | @@ -120,6 +134,8 @@ Available values: for more information. * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_TYPE+++` -- a| `default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `anonymous` |`default` @@ -136,6 +152,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.default-provider.async-crede -- Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -146,6 +164,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.default-provider.reuse-last- -- Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` --|boolean |`true` @@ -160,6 +180,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.static-provider.access-key-i [.description] -- AWS Access key id + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` --|string | @@ -169,6 +191,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.static-provider.secret-acces [.description] -- AWS Secret access key + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` --|string | @@ -178,6 +202,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.static-provider.session-toke [.description] -- AWS Session token + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` --|string | @@ -193,6 +219,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.profile-provider.profile-nam -- The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` --|string | @@ -208,6 +236,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.async-crede -- Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` --|boolean |`false` @@ -218,8 +248,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.credential- -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`15S` @@ -228,6 +260,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.process-out [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` --|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] |`1024` @@ -237,6 +271,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.command]]`l [.description] -- The command that should be executed to retrieve credentials. + +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` --|string | @@ -251,8 +287,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.connection-timeout]]`link:#quark [.description] -- The maximum amount of time to establish a connection before timing out. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -261,8 +299,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.socket-timeout]]`link:#quarkus-a [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_SOCKET_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -279,6 +319,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -289,6 +331,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.file-s [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -299,6 +343,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.file-s -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -308,6 +354,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.file-s [.description] -- Key store password + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -325,6 +373,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -335,6 +385,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.file [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -345,6 +397,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.file -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -354,6 +408,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.file [.description] -- Key store password + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -368,8 +424,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.connection-acquisition-ti [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -378,8 +436,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.connection-max-idle-time] [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`60S` @@ -388,8 +448,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.connection-time-to-live]] [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -399,6 +461,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.max-connections]]`link:#q -- The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` --|int |`50` @@ -408,6 +472,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.expect-continue-enabled]] [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` --|boolean |`true` @@ -418,6 +484,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.use-idle-connection-reape -- Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -427,6 +495,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.enabled]]`link:#qua [.description] -- Enable HTTP proxy + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` --|boolean |`false` @@ -437,6 +507,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.endpoint]]`link:#qu -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -447,6 +519,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.username]]`link:#qu [.description] -- The username to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` --|string | @@ -456,6 +530,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.password]]`link:#qu [.description] -- The password to use when connecting through a proxy. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` --|string | @@ -465,6 +541,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.ntlm-domain]]`link: [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` --|string | @@ -474,6 +552,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.ntlm-workstation]]` [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` --|string | @@ -483,6 +563,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.preemptive-basic-au [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` --|boolean | @@ -492,6 +574,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.non-proxy-hosts]]`l [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -507,6 +591,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.max-concurrency]]`link:#quarkus -- The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_MAX_CONCURRENCY+++` --|int |`50` @@ -517,6 +603,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.max-pending-connection-acquires -- The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` --|int |`10000` @@ -527,8 +615,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.read-timeout]]`link:#quarkus-am -- The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_READ_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -538,8 +628,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.write-timeout]]`link:#quarkus-a -- The amount of time to wait for a write on a socket before an exception is thrown. Specify `0` to disable. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_WRITE_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`30S` @@ -548,8 +640,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.connection-timeout]]`link:#quar [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`10S` @@ -558,8 +652,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.connection-acquisition-timeout] [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`2S` @@ -568,8 +664,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.connection-time-to-live]]`link: [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] | @@ -579,8 +677,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.connection-max-idle-time]]`link -- The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5S` @@ -590,6 +690,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.use-idle-connection-reaper]]`li -- Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` --|boolean |`true` @@ -599,6 +701,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.protocol]]`link:#quarkus-amazon [.description] -- The HTTP protocol to use. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROTOCOL+++` -- a| `http1-1`, `http2` |`http1-1` @@ -610,6 +714,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.ssl-provider]]`link:#quarkus-am -- The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_SSL_PROVIDER+++` -- a| `jdk`, `openssl`, `openssl-refcnt` | @@ -621,6 +727,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.http2.max-streams]]`link:#quark -- The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` --|long |`4294967295` @@ -631,6 +739,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.http2.initial-window-size]]`lin -- The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` --|int |`1048576` @@ -641,8 +751,10 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.http2.health-check-ping-period] -- Sets the period that the Netty client will send `PING` frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0. This setting is only respected when the HTTP/2 protocol is used. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor[icon:question-circle[], title=More information about the Duration format] + link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] |`5` @@ -651,6 +763,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.proxy.enabled]]`link:#quarkus-a [.description] -- Enable HTTP proxy. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENABLED+++` --|boolean |`false` @@ -661,6 +775,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.proxy.endpoint]]`link:#quarkus- -- The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENDPOINT+++` --|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] | @@ -671,6 +787,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.proxy.non-proxy-hosts]]`link:#q [.description] -- The hosts that the client is allowed to access without going through the proxy. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` --|list of string | @@ -688,6 +806,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -- a| `none`, `system-property`, `file-store` |`system-property` @@ -698,6 +818,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.file- [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -708,6 +830,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.file- -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -717,6 +841,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.file- [.description] -- Key store password + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -734,6 +860,8 @@ Available providers: `javax.net.ssl.keyStoreType` properties defined by the https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads a the key store from a file. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -- a| `trust-all`, `system-property`, `file-store` |`system-property` @@ -744,6 +872,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.fil [.description] -- Path to the key store. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` --|path | @@ -754,6 +884,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.fil -- Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` --|string | @@ -763,6 +895,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.fil [.description] -- Key store password + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` --|string | @@ -772,6 +906,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.event-loop.override]]`link:#qua [.description] -- Enable the custom configuration of the Netty event loop group. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` --|boolean |`false` @@ -782,6 +918,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.event-loop.number-of-threads]]` -- Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` --|int | @@ -793,6 +931,8 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.event-loop.thread-name-prefix]] The thread name prefix for threads created by this thread factory used by event loop group. The prefix will be appended with a number unique to the thread factory and a number unique to the thread. If not specified it defaults to `aws-java-sdk-NettyEventLoop` + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` --|string | @@ -803,13 +943,15 @@ a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.advanced.use-future-completion- -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. When disabled, futures will be completed on the Netty event loop thread. + +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` --|boolean |`true` |=== ifndef::no-duration-note[] [NOTE] -[[duration-note-anchor]] +[id='duration-note-anchor-{summaryTableId}'] .About the Duration format ==== The format for durations uses the standard `java.time.Duration` format. diff --git a/pom.xml b/pom.xml index bf97881c6..d756914e1 100644 --- a/pom.xml +++ b/pom.xml @@ -37,7 +37,7 @@ UTF-8 2.11.0.Final - 2.17.220 + 2.17.238