diff --git a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AbstractAmazonServiceProcessor.java b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AbstractAmazonServiceProcessor.java index 3cb8fcf2d..3b3524ff8 100644 --- a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AbstractAmazonServiceProcessor.java +++ b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AbstractAmazonServiceProcessor.java @@ -2,6 +2,7 @@ import java.util.List; import java.util.Optional; +import java.util.concurrent.ScheduledExecutorService; import java.util.function.Function; import java.util.function.Supplier; @@ -292,9 +293,11 @@ private void createClientBuilders( ? asyncClientBuilderFunction.apply(asyncSdkAsyncHttpClientBuilder.get()) : null; + ScheduledExecutorService sharedExecutorService = executorBuildItem.getExecutorProxy(); + if (syncClientBuilder != null) { syncClientBuilder = recorder.configure(syncClientBuilder, awsConfigRuntime, sdkConfigRuntime, - sdkBuildConfig, executorBuildItem.getExecutorProxy(), configName()); + sdkBuildConfig, sharedExecutorService, configName()); syntheticBeans.produce(SyntheticBeanBuildItem.configure(syncClientBuilderClass) .setRuntimeInit() .scope(ApplicationScoped.class) @@ -304,7 +307,7 @@ private void createClientBuilders( } if (asyncClientBuilder != null) { asyncClientBuilder = recorder.configure(asyncClientBuilder, awsConfigRuntime, sdkConfigRuntime, - sdkBuildConfig, executorBuildItem.getExecutorProxy(), configName()); + sdkBuildConfig, sharedExecutorService, configName()); syntheticBeans.produce(SyntheticBeanBuildItem.configure(asyncClientBuilderClass) .setRuntimeInit() .scope(ApplicationScoped.class) diff --git a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientCommonRecorder.java b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientCommonRecorder.java index b086a5d82..7c7b178a9 100644 --- a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientCommonRecorder.java +++ b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientCommonRecorder.java @@ -53,8 +53,11 @@ public void initSdkClient(SdkClientBuilder builder, String extension, SdkConfig config.endpointOverride().filter(URI::isAbsolute).ifPresent(builder::endpointOverride); final ClientOverrideConfiguration.Builder overrides = ClientOverrideConfiguration.builder(); - // use quarkus executor service - overrides.scheduledExecutorService(scheduledExecutorService); + + if (config.advanced().useQuarkusScheduledExecutorService()) { + // use quarkus executor service + overrides.scheduledExecutorService(scheduledExecutorService); + } config.apiCallTimeout().ifPresent(overrides::apiCallTimeout); config.apiCallAttemptTimeout().ifPresent(overrides::apiCallAttemptTimeout); diff --git a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/SdkConfig.java b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/SdkConfig.java index 7443856a5..8bfe91657 100644 --- a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/SdkConfig.java +++ b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/SdkConfig.java @@ -7,6 +7,7 @@ import io.quarkus.runtime.annotations.ConfigGroup; import io.quarkus.runtime.configuration.DurationConverter; import io.smallrye.config.WithConverter; +import io.smallrye.config.WithDefault; /** * AWS SDK specific configurations @@ -42,4 +43,22 @@ public interface SdkConfig { */ @WithConverter(DurationConverter.class) Optional apiCallAttemptTimeout(); + + /** + * sdk client advanced options + */ + Advanced advanced(); + + @ConfigGroup + public interface Advanced { + + /** + * Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + *

+ * When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in + * competition for CPU resources among these thread pools. + */ + @WithDefault("true") + boolean useQuarkusScheduledExecutorService(); + } } diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc index 9c6cdc1f5..2c4ff9629 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.interceptors]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.interceptors[quarkus.cognito-user-pools.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.type[quarkus.cognito-user-pools.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.type[quarkus.cognito-user-pools.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.devservices.enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.devservices.enabled[quarkus.cognito-user-pools.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.devservices.shared]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.devservices.shared[quarkus.cognito-user-pools.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.devservices.service-name]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.devservices.service-name[quarkus.cognito-user-pools.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.devservices.container-properties-container-properties]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.devservices.container-properties-container-properties[quarkus.cognito-user-pools.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -139,6 +146,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.endpoint-override]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.endpoint-override[quarkus.cognito-user-pools.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -158,6 +166,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.api-call-timeout]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.api-call-timeout[quarkus.cognito-user-pools.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -179,6 +188,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.api-call-attempt-timeout]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.api-call-attempt-timeout[quarkus.cognito-user-pools.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -196,6 +206,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.advanced.use-quarkus-scheduled-executor-service[quarkus.cognito-user-pools.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws-aws-services-configurations]]link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws-aws-services-configurations[AWS services configurations] h|Type @@ -203,6 +232,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.region]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.region[quarkus.cognito-user-pools.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -230,6 +260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.type[quarkus.cognito-user-pools.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -275,6 +306,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.default-provider.async-credential-update-enabled[quarkus.cognito-user-pools.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -293,6 +325,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.cognito-user-pools.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -316,6 +349,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.static-provider.access-key-id[quarkus.cognito-user-pools.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -332,6 +366,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.static-provider.secret-access-key[quarkus.cognito-user-pools.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.static-provider.session-token[quarkus.cognito-user-pools.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -369,6 +405,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.profile-provider.profile-name[quarkus.cognito-user-pools.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -392,6 +429,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.process-provider.async-credential-update-enabled[quarkus.cognito-user-pools.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -410,6 +448,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.process-provider.credential-refresh-threshold[quarkus.cognito-user-pools.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -429,6 +468,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.process-provider.process-output-limit[quarkus.cognito-user-pools.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.process-provider.command]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.process-provider.command[quarkus.cognito-user-pools.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -466,6 +507,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.aws.credentials.custom-provider.name[quarkus.cognito-user-pools.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -487,6 +529,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.connection-timeout]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.connection-timeout[quarkus.cognito-user-pools.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -504,6 +547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.socket-timeout]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.socket-timeout[quarkus.cognito-user-pools.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -521,6 +565,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.type[quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -546,6 +591,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.path[quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.type[quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -580,6 +627,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.password[quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.type[quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -621,6 +670,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.path[quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.type[quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -655,6 +706,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.password[quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -676,6 +728,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.connection-acquisition-timeout[quarkus.cognito-user-pools.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -693,6 +746,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.connection-max-idle-time[quarkus.cognito-user-pools.sync-client.apache.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -710,6 +764,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.connection-time-to-live[quarkus.cognito-user-pools.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. @@ -727,6 +782,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.max-connections]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.max-connections[quarkus.cognito-user-pools.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -745,6 +801,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.expect-continue-enabled[quarkus.cognito-user-pools.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.use-idle-connection-reaper[quarkus.cognito-user-pools.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -779,6 +837,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.tcp-keep-alive[quarkus.cognito-user-pools.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.enabled[quarkus.cognito-user-pools.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.endpoint[quarkus.cognito-user-pools.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -830,6 +891,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.username]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.username[quarkus.cognito-user-pools.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.password]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.password[quarkus.cognito-user-pools.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.ntlm-domain[quarkus.cognito-user-pools.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.ntlm-workstation[quarkus.cognito-user-pools.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.cognito-user-pools.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.sync-client.apache.proxy.non-proxy-hosts[quarkus.cognito-user-pools.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -931,6 +998,7 @@ h|Default a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.max-concurrency]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.max-concurrency[quarkus.cognito-user-pools.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -949,6 +1017,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.max-pending-connection-acquires[quarkus.cognito-user-pools.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -967,6 +1036,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.read-timeout]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.read-timeout[quarkus.cognito-user-pools.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -986,6 +1056,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.write-timeout]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.write-timeout[quarkus.cognito-user-pools.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1005,6 +1076,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.connection-timeout]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.connection-timeout[quarkus.cognito-user-pools.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1022,6 +1094,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.connection-acquisition-timeout[quarkus.cognito-user-pools.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. @@ -1039,6 +1112,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.connection-time-to-live]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.connection-time-to-live[quarkus.cognito-user-pools.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1056,6 +1130,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.connection-max-idle-time]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.connection-max-idle-time[quarkus.cognito-user-pools.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1075,6 +1150,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.use-idle-connection-reaper[quarkus.cognito-user-pools.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1093,6 +1169,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tcp-keep-alive]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tcp-keep-alive[quarkus.cognito-user-pools.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.protocol]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.protocol[quarkus.cognito-user-pools.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1126,6 +1204,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.ssl-provider]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.ssl-provider[quarkus.cognito-user-pools.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1145,6 +1224,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.http2.max-streams]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.http2.max-streams[quarkus.cognito-user-pools.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1163,6 +1243,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.http2.initial-window-size]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.http2.initial-window-size[quarkus.cognito-user-pools.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1181,6 +1262,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.http2.health-check-ping-period[quarkus.cognito-user-pools.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1200,6 +1282,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.proxy.enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.proxy.enabled[quarkus.cognito-user-pools.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.proxy.endpoint]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.proxy.endpoint[quarkus.cognito-user-pools.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1235,6 +1319,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.proxy.non-proxy-hosts[quarkus.cognito-user-pools.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-key-managers-provider.type[quarkus.cognito-user-pools.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1276,6 +1362,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.path[quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.type[quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1310,6 +1398,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.password[quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.type[quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1351,6 +1441,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.path[quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.type[quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1385,6 +1477,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.password[quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.event-loop.override]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.event-loop.override[quarkus.cognito-user-pools.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.event-loop.number-of-threads[quarkus.cognito-user-pools.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1435,6 +1530,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.event-loop.thread-name-prefix[quarkus.cognito-user-pools.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1455,6 +1551,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-cognitouserpools_quarkus.cognito-user-pools.async-client.advanced.use-future-completion-thread-pool[quarkus.cognito-user-pools.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced.adoc index a76968902..978e4f89b 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb-enhanced_quarkus.dynamodbenhanced.client-extensions]]`link:#quarkus-amazon-dynamodb-enhanced_quarkus.dynamodbenhanced.client-extensions[quarkus.dynamodbenhanced.client-extensions]` + [.description] -- List of extensions to load with the enhanced client. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb-enhanced_quarkus.dynamodbenhanced.create-table-schemas]]`link:#quarkus-amazon-dynamodb-enhanced_quarkus.dynamodbenhanced.create-table-schemas[quarkus.dynamodbenhanced.create-table-schemas]` + [.description] -- Whether a `TableSchema` should be created at start up for DynamoDb mappable entities annotated with `DynamoDbBean` or `DynamoDbImmutable` diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc index bed7419e5..c92e9fc7e 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus.dynamodb.interceptors]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.interceptors[quarkus.dynamodb.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.type[quarkus.dynamodb.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.type[quarkus.dynamodb.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus.dynamodb.devservices.enabled]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.devservices.enabled[quarkus.dynamodb.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus.dynamodb.devservices.shared]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.devservices.shared[quarkus.dynamodb.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus.dynamodb.devservices.service-name]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.devservices.service-name[quarkus.dynamodb.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.enable-endpoint-discovery]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.enable-endpoint-discovery[quarkus.dynamodb.enable-endpoint-discovery]` + [.description] -- Enable DynamoDB service endpoint discovery. @@ -134,6 +141,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus.dynamodb.devservices.container-properties-container-properties]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.devservices.container-properties-container-properties[quarkus.dynamodb.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -155,6 +163,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.endpoint-override]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.endpoint-override[quarkus.dynamodb.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -174,6 +183,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.api-call-timeout]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.api-call-timeout[quarkus.dynamodb.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -195,6 +205,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.api-call-attempt-timeout]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.api-call-attempt-timeout[quarkus.dynamodb.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -212,6 +223,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.advanced.use-quarkus-scheduled-executor-service[quarkus.dynamodb.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-dynamodb_quarkus.dynamodb.aws-aws-services-configurations]]link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws-aws-services-configurations[AWS services configurations] h|Type @@ -219,6 +249,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.region]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.region[quarkus.dynamodb.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -246,6 +277,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.type[quarkus.dynamodb.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -291,6 +323,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.default-provider.async-credential-update-enabled[quarkus.dynamodb.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -309,6 +342,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.dynamodb.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -332,6 +366,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.static-provider.access-key-id[quarkus.dynamodb.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.static-provider.secret-access-key[quarkus.dynamodb.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -364,6 +400,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.static-provider.session-token[quarkus.dynamodb.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -385,6 +422,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.profile-provider.profile-name[quarkus.dynamodb.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -408,6 +446,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.async-credential-update-enabled[quarkus.dynamodb.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -426,6 +465,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.credential-refresh-threshold[quarkus.dynamodb.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.process-output-limit[quarkus.dynamodb.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -461,6 +502,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.command]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.process-provider.command[quarkus.dynamodb.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -482,6 +524,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.aws.credentials.custom-provider.name[quarkus.dynamodb.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -503,6 +546,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.connection-timeout]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.connection-timeout[quarkus.dynamodb.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -520,6 +564,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.socket-timeout]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.socket-timeout[quarkus.dynamodb.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -537,6 +582,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provider.type[quarkus.dynamodb.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.path[quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -578,6 +625,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.type[quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.password[quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -612,6 +661,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-provider.type[quarkus.dynamodb.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.path[quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -653,6 +704,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.type[quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -671,6 +723,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.password[quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -692,6 +745,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.connection-acquisition-timeout[quarkus.dynamodb.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -709,6 +763,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.connection-max-idle-time[quarkus.dynamodb.sync-client.apache.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -726,6 +781,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.connection-time-to-live[quarkus.dynamodb.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. @@ -743,6 +799,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.max-connections]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.max-connections[quarkus.dynamodb.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.expect-continue-enabled[quarkus.dynamodb.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -777,6 +835,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.use-idle-connection-reaper[quarkus.dynamodb.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.tcp-keep-alive[quarkus.dynamodb.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.enabled[quarkus.dynamodb.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -827,6 +888,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.endpoint[quarkus.dynamodb.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.username]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.username[quarkus.dynamodb.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.password]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.password[quarkus.dynamodb.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.ntlm-domain[quarkus.dynamodb.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.ntlm-workstation[quarkus.dynamodb.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.dynamodb.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -926,6 +993,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.sync-client.apache.proxy.non-proxy-hosts[quarkus.dynamodb.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -947,6 +1015,7 @@ h|Default a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.max-concurrency]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.max-concurrency[quarkus.dynamodb.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -965,6 +1034,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.max-pending-connection-acquires[quarkus.dynamodb.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -983,6 +1053,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.read-timeout]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.read-timeout[quarkus.dynamodb.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -1002,6 +1073,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.write-timeout]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.write-timeout[quarkus.dynamodb.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1021,6 +1093,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-timeout]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-timeout[quarkus.dynamodb.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1038,6 +1111,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-acquisition-timeout[quarkus.dynamodb.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. @@ -1055,6 +1129,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-time-to-live]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-time-to-live[quarkus.dynamodb.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1072,6 +1147,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-max-idle-time]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.connection-max-idle-time[quarkus.dynamodb.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1091,6 +1167,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.use-idle-connection-reaper[quarkus.dynamodb.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tcp-keep-alive]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tcp-keep-alive[quarkus.dynamodb.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1125,6 +1203,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.protocol]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.protocol[quarkus.dynamodb.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1142,6 +1221,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.ssl-provider]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.ssl-provider[quarkus.dynamodb.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1161,6 +1241,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.http2.max-streams]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.http2.max-streams[quarkus.dynamodb.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1179,6 +1260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.http2.initial-window-size]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.http2.initial-window-size[quarkus.dynamodb.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1197,6 +1279,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.http2.health-check-ping-period[quarkus.dynamodb.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.proxy.enabled]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.proxy.enabled[quarkus.dynamodb.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1232,6 +1316,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.proxy.endpoint]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.proxy.endpoint[quarkus.dynamodb.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.proxy.non-proxy-hosts[quarkus.dynamodb.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1267,6 +1353,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-provider.type[quarkus.dynamodb.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.path[quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1308,6 +1396,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.type[quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.password[quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1342,6 +1432,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-provider.type[quarkus.dynamodb.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.path[quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1383,6 +1475,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.type[quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.password[quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.event-loop.override]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.event-loop.override[quarkus.dynamodb.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1433,6 +1528,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.event-loop.number-of-threads[quarkus.dynamodb.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1451,6 +1547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.event-loop.thread-name-prefix[quarkus.dynamodb.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1471,6 +1568,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-dynamodb_quarkus.dynamodb.async-client.advanced.use-future-completion-thread-pool[quarkus.dynamodb.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc index 8b4c22481..932f14142 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus.iam.interceptors]]`link:#quarkus-amazon-iam_quarkus.iam.interceptors[quarkus.iam.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus.iam.sync-client.type]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.type[quarkus.iam.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus.iam.async-client.type]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.type[quarkus.iam.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus.iam.devservices.enabled]]`link:#quarkus-amazon-iam_quarkus.iam.devservices.enabled[quarkus.iam.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus.iam.devservices.shared]]`link:#quarkus-amazon-iam_quarkus.iam.devservices.shared[quarkus.iam.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus.iam.devservices.service-name]]`link:#quarkus-amazon-iam_quarkus.iam.devservices.service-name[quarkus.iam.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus.iam.devservices.container-properties-container-properties]]`link:#quarkus-amazon-iam_quarkus.iam.devservices.container-properties-container-properties[quarkus.iam.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -139,6 +146,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.endpoint-override]]`link:#quarkus-amazon-iam_quarkus.iam.endpoint-override[quarkus.iam.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -158,6 +166,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.api-call-timeout]]`link:#quarkus-amazon-iam_quarkus.iam.api-call-timeout[quarkus.iam.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -179,6 +188,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.api-call-attempt-timeout]]`link:#quarkus-amazon-iam_quarkus.iam.api-call-attempt-timeout[quarkus.iam.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -196,6 +206,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-iam_quarkus.iam.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-iam_quarkus.iam.advanced.use-quarkus-scheduled-executor-service[quarkus.iam.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-iam_quarkus.iam.aws-aws-services-configurations]]link:#quarkus-amazon-iam_quarkus.iam.aws-aws-services-configurations[AWS services configurations] h|Type @@ -203,6 +232,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.aws.region]]`link:#quarkus-amazon-iam_quarkus.iam.aws.region[quarkus.iam.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -230,6 +260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.type]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.type[quarkus.iam.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -275,6 +306,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.default-provider.async-credential-update-enabled[quarkus.iam.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -293,6 +325,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.iam.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -316,6 +349,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.static-provider.access-key-id[quarkus.iam.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -332,6 +366,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.static-provider.secret-access-key[quarkus.iam.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.static-provider.session-token[quarkus.iam.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -369,6 +405,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.profile-provider.profile-name[quarkus.iam.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -392,6 +429,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.async-credential-update-enabled[quarkus.iam.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -410,6 +448,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.credential-refresh-threshold[quarkus.iam.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -429,6 +468,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.process-output-limit[quarkus.iam.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.command]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.process-provider.command[quarkus.iam.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -466,6 +507,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-iam_quarkus.iam.aws.credentials.custom-provider.name[quarkus.iam.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -487,6 +529,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.sync-client.connection-timeout]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.connection-timeout[quarkus.iam.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -504,6 +547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.socket-timeout]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.socket-timeout[quarkus.iam.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -521,6 +565,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.type[quarkus.iam.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -546,6 +591,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.file-store.path[quarkus.iam.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.file-store.type[quarkus.iam.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -580,6 +627,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.tls-key-managers-provider.file-store.password[quarkus.iam.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.type[quarkus.iam.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -621,6 +670,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.file-store.path[quarkus.iam.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.file-store.type[quarkus.iam.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -655,6 +706,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.tls-trust-managers-provider.file-store.password[quarkus.iam.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -676,6 +728,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.connection-acquisition-timeout[quarkus.iam.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -693,6 +746,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.connection-max-idle-time[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. @@ -710,6 +764,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.connection-time-to-live[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. @@ -727,6 +782,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.max-connections]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.max-connections[quarkus.iam.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -745,6 +801,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.expect-continue-enabled[quarkus.iam.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.use-idle-connection-reaper[quarkus.iam.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -779,6 +837,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.tcp-keep-alive[quarkus.iam.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.enabled[quarkus.iam.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.endpoint[quarkus.iam.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -830,6 +891,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.username]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.username[quarkus.iam.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.password]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.password[quarkus.iam.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.ntlm-domain[quarkus.iam.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.ntlm-workstation[quarkus.iam.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.iam.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-iam_quarkus.iam.sync-client.apache.proxy.non-proxy-hosts[quarkus.iam.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -931,6 +998,7 @@ h|Default a| [[quarkus-amazon-iam_quarkus.iam.async-client.max-concurrency]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.max-concurrency[quarkus.iam.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -949,6 +1017,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.max-pending-connection-acquires[quarkus.iam.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -967,6 +1036,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.read-timeout]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.read-timeout[quarkus.iam.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -986,6 +1056,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.write-timeout]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.write-timeout[quarkus.iam.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1005,6 +1076,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.connection-timeout]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.connection-timeout[quarkus.iam.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1022,6 +1094,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.connection-acquisition-timeout[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. @@ -1039,6 +1112,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.connection-time-to-live]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.connection-time-to-live[quarkus.iam.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1056,6 +1130,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.connection-max-idle-time]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.connection-max-idle-time[quarkus.iam.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1075,6 +1150,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.use-idle-connection-reaper[quarkus.iam.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1093,6 +1169,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.tcp-keep-alive]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.tcp-keep-alive[quarkus.iam.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.protocol]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.protocol[quarkus.iam.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1126,6 +1204,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.ssl-provider]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.ssl-provider[quarkus.iam.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1145,6 +1224,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.http2.max-streams]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.http2.max-streams[quarkus.iam.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1163,6 +1243,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.http2.initial-window-size]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.http2.initial-window-size[quarkus.iam.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1181,6 +1262,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.http2.health-check-ping-period[quarkus.iam.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1200,6 +1282,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.proxy.enabled]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.proxy.enabled[quarkus.iam.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.proxy.endpoint]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.proxy.endpoint[quarkus.iam.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1235,6 +1319,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.proxy.non-proxy-hosts[quarkus.iam.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.type[quarkus.iam.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1276,6 +1362,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.file-store.path[quarkus.iam.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.file-store.type[quarkus.iam.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1310,6 +1398,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.tls-key-managers-provider.file-store.password[quarkus.iam.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.type[quarkus.iam.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1351,6 +1441,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.file-store.path[quarkus.iam.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.file-store.type[quarkus.iam.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1385,6 +1477,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.tls-trust-managers-provider.file-store.password[quarkus.iam.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.event-loop.override]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.event-loop.override[quarkus.iam.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.event-loop.number-of-threads[quarkus.iam.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1435,6 +1530,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.event-loop.thread-name-prefix[quarkus.iam.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1455,6 +1551,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-iam_quarkus.iam.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-iam_quarkus.iam.async-client.advanced.use-future-completion-thread-pool[quarkus.iam.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc index d8302940b..cc39454d5 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus.kms.interceptors]]`link:#quarkus-amazon-kms_quarkus.kms.interceptors[quarkus.kms.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus.kms.sync-client.type]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.type[quarkus.kms.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus.kms.async-client.type]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.type[quarkus.kms.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus.kms.devservices.enabled]]`link:#quarkus-amazon-kms_quarkus.kms.devservices.enabled[quarkus.kms.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus.kms.devservices.shared]]`link:#quarkus-amazon-kms_quarkus.kms.devservices.shared[quarkus.kms.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus.kms.devservices.service-name]]`link:#quarkus-amazon-kms_quarkus.kms.devservices.service-name[quarkus.kms.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus.kms.devservices.container-properties-container-properties]]`link:#quarkus-amazon-kms_quarkus.kms.devservices.container-properties-container-properties[quarkus.kms.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -139,6 +146,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.endpoint-override]]`link:#quarkus-amazon-kms_quarkus.kms.endpoint-override[quarkus.kms.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -158,6 +166,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.api-call-timeout]]`link:#quarkus-amazon-kms_quarkus.kms.api-call-timeout[quarkus.kms.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -179,6 +188,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.api-call-attempt-timeout]]`link:#quarkus-amazon-kms_quarkus.kms.api-call-attempt-timeout[quarkus.kms.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -196,6 +206,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-kms_quarkus.kms.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-kms_quarkus.kms.advanced.use-quarkus-scheduled-executor-service[quarkus.kms.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-kms_quarkus.kms.aws-aws-services-configurations]]link:#quarkus-amazon-kms_quarkus.kms.aws-aws-services-configurations[AWS services configurations] h|Type @@ -203,6 +232,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.aws.region]]`link:#quarkus-amazon-kms_quarkus.kms.aws.region[quarkus.kms.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -230,6 +260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.type]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.type[quarkus.kms.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -275,6 +306,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.default-provider.async-credential-update-enabled[quarkus.kms.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -293,6 +325,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.kms.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -316,6 +349,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.static-provider.access-key-id[quarkus.kms.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -332,6 +366,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.static-provider.secret-access-key[quarkus.kms.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.static-provider.session-token[quarkus.kms.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -369,6 +405,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.profile-provider.profile-name[quarkus.kms.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -392,6 +429,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.async-credential-update-enabled[quarkus.kms.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -410,6 +448,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.credential-refresh-threshold[quarkus.kms.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -429,6 +468,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.process-output-limit[quarkus.kms.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.command]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.process-provider.command[quarkus.kms.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -466,6 +507,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-kms_quarkus.kms.aws.credentials.custom-provider.name[quarkus.kms.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -487,6 +529,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.sync-client.connection-timeout]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.connection-timeout[quarkus.kms.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -504,6 +547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.socket-timeout]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.socket-timeout[quarkus.kms.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -521,6 +565,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.type[quarkus.kms.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -546,6 +591,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.file-store.path[quarkus.kms.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.file-store.type[quarkus.kms.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -580,6 +627,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.tls-key-managers-provider.file-store.password[quarkus.kms.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.type[quarkus.kms.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -621,6 +670,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.file-store.path[quarkus.kms.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.file-store.type[quarkus.kms.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -655,6 +706,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.tls-trust-managers-provider.file-store.password[quarkus.kms.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -676,6 +728,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.connection-acquisition-timeout[quarkus.kms.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -693,6 +746,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.connection-max-idle-time[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. @@ -710,6 +764,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.connection-time-to-live[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. @@ -727,6 +782,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.max-connections]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.max-connections[quarkus.kms.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -745,6 +801,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.expect-continue-enabled[quarkus.kms.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.use-idle-connection-reaper[quarkus.kms.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -779,6 +837,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.tcp-keep-alive[quarkus.kms.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.enabled[quarkus.kms.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.endpoint[quarkus.kms.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -830,6 +891,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.username]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.username[quarkus.kms.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.password]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.password[quarkus.kms.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.ntlm-domain[quarkus.kms.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.ntlm-workstation[quarkus.kms.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.kms.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-kms_quarkus.kms.sync-client.apache.proxy.non-proxy-hosts[quarkus.kms.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -931,6 +998,7 @@ h|Default a| [[quarkus-amazon-kms_quarkus.kms.async-client.max-concurrency]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.max-concurrency[quarkus.kms.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -949,6 +1017,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.max-pending-connection-acquires[quarkus.kms.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -967,6 +1036,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.read-timeout]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.read-timeout[quarkus.kms.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -986,6 +1056,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.write-timeout]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.write-timeout[quarkus.kms.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1005,6 +1076,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.connection-timeout]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.connection-timeout[quarkus.kms.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1022,6 +1094,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.connection-acquisition-timeout[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. @@ -1039,6 +1112,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.connection-time-to-live]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.connection-time-to-live[quarkus.kms.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1056,6 +1130,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.connection-max-idle-time]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.connection-max-idle-time[quarkus.kms.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1075,6 +1150,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.use-idle-connection-reaper[quarkus.kms.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1093,6 +1169,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.tcp-keep-alive]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.tcp-keep-alive[quarkus.kms.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.protocol]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.protocol[quarkus.kms.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1126,6 +1204,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.ssl-provider]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.ssl-provider[quarkus.kms.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1145,6 +1224,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.http2.max-streams]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.http2.max-streams[quarkus.kms.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1163,6 +1243,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.http2.initial-window-size]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.http2.initial-window-size[quarkus.kms.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1181,6 +1262,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.http2.health-check-ping-period[quarkus.kms.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1200,6 +1282,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.proxy.enabled]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.proxy.enabled[quarkus.kms.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.proxy.endpoint]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.proxy.endpoint[quarkus.kms.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1235,6 +1319,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.proxy.non-proxy-hosts[quarkus.kms.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.type[quarkus.kms.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1276,6 +1362,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.file-store.path[quarkus.kms.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.file-store.type[quarkus.kms.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1310,6 +1398,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.tls-key-managers-provider.file-store.password[quarkus.kms.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.type[quarkus.kms.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1351,6 +1441,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.file-store.path[quarkus.kms.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.file-store.type[quarkus.kms.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1385,6 +1477,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.tls-trust-managers-provider.file-store.password[quarkus.kms.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.event-loop.override]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.event-loop.override[quarkus.kms.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.event-loop.number-of-threads[quarkus.kms.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1435,6 +1530,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.event-loop.thread-name-prefix[quarkus.kms.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1455,6 +1551,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-kms_quarkus.kms.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-kms_quarkus.kms.async-client.advanced.use-future-completion-thread-pool[quarkus.kms.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc index f53a29c51..2cc5ac992 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.interceptors]]`link:#quarkus-amazon-s3_quarkus.s3.interceptors[quarkus.s3.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.sync-client.type]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.type[quarkus.s3.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.async-client.type]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.type[quarkus.s3.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.devservices.enabled]]`link:#quarkus-amazon-s3_quarkus.s3.devservices.enabled[quarkus.s3.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.devservices.shared]]`link:#quarkus-amazon-s3_quarkus.s3.devservices.shared[quarkus.s3.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.devservices.service-name]]`link:#quarkus-amazon-s3_quarkus.s3.devservices.service-name[quarkus.s3.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.devservices.buckets]]`link:#quarkus-amazon-s3_quarkus.s3.devservices.buckets[quarkus.s3.devservices.buckets]` + [.description] -- The buckets to create on startup. @@ -134,6 +141,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.accelerate-mode]]`link:#quarkus-amazon-s3_quarkus.s3.accelerate-mode[quarkus.s3.accelerate-mode]` + [.description] -- Enable using the accelerate endpoint when accessing S3. @@ -152,6 +160,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.checksum-validation]]`link:#quarkus-amazon-s3_quarkus.s3.checksum-validation[quarkus.s3.checksum-validation]` + [.description] -- Enable doing a validation of the checksum of an object stored in S3. @@ -168,6 +177,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.chunked-encoding]]`link:#quarkus-amazon-s3_quarkus.s3.chunked-encoding[quarkus.s3.chunked-encoding]` + [.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`. @@ -184,6 +194,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.dualstack]]`link:#quarkus-amazon-s3_quarkus.s3.dualstack[quarkus.s3.dualstack]` + [.description] -- Enable dualstack mode for accessing S3. If you want to use IPv6 when accessing S3, dualstack must be enabled. @@ -200,6 +211,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.path-style-access]]`link:#quarkus-amazon-s3_quarkus.s3.path-style-access[quarkus.s3.path-style-access]` + [.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. @@ -216,6 +228,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.use-arn-region-enabled]]`link:#quarkus-amazon-s3_quarkus.s3.use-arn-region-enabled[quarkus.s3.use-arn-region-enabled]` + [.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. @@ -232,6 +245,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.profile-name]]`link:#quarkus-amazon-s3_quarkus.s3.profile-name[quarkus.s3.profile-name]` + [.description] -- 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'. @@ -250,6 +264,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus.s3.devservices.container-properties-container-properties]]`link:#quarkus-amazon-s3_quarkus.s3.devservices.container-properties-container-properties[quarkus.s3.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -271,6 +286,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.endpoint-override]]`link:#quarkus-amazon-s3_quarkus.s3.endpoint-override[quarkus.s3.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -290,6 +306,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.api-call-timeout]]`link:#quarkus-amazon-s3_quarkus.s3.api-call-timeout[quarkus.s3.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -311,6 +328,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.api-call-attempt-timeout]]`link:#quarkus-amazon-s3_quarkus.s3.api-call-attempt-timeout[quarkus.s3.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -328,6 +346,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-s3_quarkus.s3.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-s3_quarkus.s3.advanced.use-quarkus-scheduled-executor-service[quarkus.s3.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-s3_quarkus.s3.aws-aws-services-configurations]]link:#quarkus-amazon-s3_quarkus.s3.aws-aws-services-configurations[AWS services configurations] h|Type @@ -335,6 +372,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.aws.region]]`link:#quarkus-amazon-s3_quarkus.s3.aws.region[quarkus.s3.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -362,6 +400,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.type]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.type[quarkus.s3.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -407,6 +446,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.default-provider.async-credential-update-enabled[quarkus.s3.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -425,6 +465,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.s3.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -448,6 +489,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.static-provider.access-key-id[quarkus.s3.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -464,6 +506,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.static-provider.secret-access-key[quarkus.s3.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -480,6 +523,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.static-provider.session-token[quarkus.s3.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -501,6 +545,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.profile-provider.profile-name[quarkus.s3.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -524,6 +569,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.async-credential-update-enabled[quarkus.s3.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -542,6 +588,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.credential-refresh-threshold[quarkus.s3.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -561,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.process-output-limit[quarkus.s3.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -577,6 +625,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.command]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.process-provider.command[quarkus.s3.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -598,6 +647,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-s3_quarkus.s3.aws.credentials.custom-provider.name[quarkus.s3.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -619,6 +669,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.sync-client.connection-timeout]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.connection-timeout[quarkus.s3.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -636,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.socket-timeout]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.socket-timeout[quarkus.s3.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -653,6 +705,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.type[quarkus.s3.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -678,6 +731,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.file-store.path[quarkus.s3.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -694,6 +748,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.file-store.type[quarkus.s3.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -712,6 +767,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.tls-key-managers-provider.file-store.password[quarkus.s3.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -728,6 +784,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.type[quarkus.s3.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -753,6 +810,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.file-store.path[quarkus.s3.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -769,6 +827,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.file-store.type[quarkus.s3.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -787,6 +846,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.tls-trust-managers-provider.file-store.password[quarkus.s3.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -808,6 +868,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.connection-acquisition-timeout[quarkus.s3.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -825,6 +886,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.connection-max-idle-time[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. @@ -842,6 +904,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.connection-time-to-live[quarkus.s3.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. @@ -859,6 +922,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.max-connections]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.max-connections[quarkus.s3.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -877,6 +941,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.expect-continue-enabled[quarkus.s3.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -893,6 +958,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.use-idle-connection-reaper[quarkus.s3.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -911,6 +977,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.tcp-keep-alive[quarkus.s3.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -927,6 +994,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.enabled[quarkus.s3.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -943,6 +1011,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.endpoint[quarkus.s3.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -962,6 +1031,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.username]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.username[quarkus.s3.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -978,6 +1048,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.password]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.password[quarkus.s3.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -994,6 +1065,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.ntlm-domain[quarkus.s3.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -1010,6 +1082,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.ntlm-workstation[quarkus.s3.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -1026,6 +1099,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.s3.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -1042,6 +1116,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-s3_quarkus.s3.sync-client.apache.proxy.non-proxy-hosts[quarkus.s3.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1063,6 +1138,7 @@ h|Default a| [[quarkus-amazon-s3_quarkus.s3.async-client.max-concurrency]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.max-concurrency[quarkus.s3.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -1081,6 +1157,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.max-pending-connection-acquires[quarkus.s3.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -1099,6 +1176,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.read-timeout]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.read-timeout[quarkus.s3.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -1118,6 +1196,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.write-timeout]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.write-timeout[quarkus.s3.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1137,6 +1216,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.connection-timeout]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.connection-timeout[quarkus.s3.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1154,6 +1234,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.connection-acquisition-timeout[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. @@ -1171,6 +1252,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.connection-time-to-live]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.connection-time-to-live[quarkus.s3.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1188,6 +1270,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.connection-max-idle-time]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.connection-max-idle-time[quarkus.s3.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1207,6 +1290,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.use-idle-connection-reaper[quarkus.s3.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1225,6 +1309,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.tcp-keep-alive]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.tcp-keep-alive[quarkus.s3.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1241,6 +1326,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.protocol]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.protocol[quarkus.s3.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1258,6 +1344,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.ssl-provider]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.ssl-provider[quarkus.s3.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1277,6 +1364,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.http2.max-streams]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.http2.max-streams[quarkus.s3.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1295,6 +1383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.http2.initial-window-size]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.http2.initial-window-size[quarkus.s3.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1313,6 +1402,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.http2.health-check-ping-period[quarkus.s3.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1332,6 +1422,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.proxy.enabled]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.proxy.enabled[quarkus.s3.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1348,6 +1439,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.proxy.endpoint]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.proxy.endpoint[quarkus.s3.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1367,6 +1459,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.proxy.non-proxy-hosts[quarkus.s3.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1383,6 +1476,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.type[quarkus.s3.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1408,6 +1502,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.file-store.path[quarkus.s3.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1424,6 +1519,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.file-store.type[quarkus.s3.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1442,6 +1538,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.tls-key-managers-provider.file-store.password[quarkus.s3.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1458,6 +1555,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.type[quarkus.s3.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1483,6 +1581,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.file-store.path[quarkus.s3.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1499,6 +1598,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.file-store.type[quarkus.s3.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1517,6 +1617,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.tls-trust-managers-provider.file-store.password[quarkus.s3.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1533,6 +1634,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.event-loop.override]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.event-loop.override[quarkus.s3.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1549,6 +1651,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.event-loop.number-of-threads[quarkus.s3.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1567,6 +1670,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.event-loop.thread-name-prefix[quarkus.s3.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1587,6 +1691,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-s3_quarkus.s3.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-s3_quarkus.s3.async-client.advanced.use-future-completion-thread-pool[quarkus.s3.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc index 8ee4c74bc..b3b9aee8d 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.interceptors]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.interceptors[quarkus.secretsmanager.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.type[quarkus.secretsmanager.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.type[quarkus.secretsmanager.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.devservices.enabled]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.devservices.enabled[quarkus.secretsmanager.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.devservices.shared]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.devservices.shared[quarkus.secretsmanager.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.devservices.service-name]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.devservices.service-name[quarkus.secretsmanager.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.devservices.container-properties-container-properties]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.devservices.container-properties-container-properties[quarkus.secretsmanager.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -139,6 +146,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.endpoint-override]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.endpoint-override[quarkus.secretsmanager.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -158,6 +166,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.api-call-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.api-call-timeout[quarkus.secretsmanager.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -179,6 +188,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.api-call-attempt-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.api-call-attempt-timeout[quarkus.secretsmanager.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -196,6 +206,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.advanced.use-quarkus-scheduled-executor-service[quarkus.secretsmanager.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws-aws-services-configurations]]link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws-aws-services-configurations[AWS services configurations] h|Type @@ -203,6 +232,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.region]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.region[quarkus.secretsmanager.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -230,6 +260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.type[quarkus.secretsmanager.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -275,6 +306,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.default-provider.async-credential-update-enabled[quarkus.secretsmanager.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -293,6 +325,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.secretsmanager.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -316,6 +349,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.static-provider.access-key-id[quarkus.secretsmanager.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -332,6 +366,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.static-provider.secret-access-key[quarkus.secretsmanager.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.static-provider.session-token[quarkus.secretsmanager.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -369,6 +405,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.profile-provider.profile-name[quarkus.secretsmanager.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -392,6 +429,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.process-provider.async-credential-update-enabled[quarkus.secretsmanager.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -410,6 +448,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.process-provider.credential-refresh-threshold[quarkus.secretsmanager.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -429,6 +468,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.process-provider.process-output-limit[quarkus.secretsmanager.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.process-provider.command]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.process-provider.command[quarkus.secretsmanager.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -466,6 +507,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.aws.credentials.custom-provider.name[quarkus.secretsmanager.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -487,6 +529,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.connection-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.connection-timeout[quarkus.secretsmanager.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -504,6 +547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.socket-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.socket-timeout[quarkus.secretsmanager.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -521,6 +565,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-managers-provider.type[quarkus.secretsmanager.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -546,6 +591,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.path[quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.type[quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -580,6 +627,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.password[quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust-managers-provider.type[quarkus.secretsmanager.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -621,6 +670,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.path[quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.type[quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -655,6 +706,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.password[quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -676,6 +728,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.connection-acquisition-timeout[quarkus.secretsmanager.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -693,6 +746,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.connection-max-idle-time[quarkus.secretsmanager.sync-client.apache.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -710,6 +764,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.connection-time-to-live[quarkus.secretsmanager.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. @@ -727,6 +782,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.max-connections]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.max-connections[quarkus.secretsmanager.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -745,6 +801,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.expect-continue-enabled[quarkus.secretsmanager.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.use-idle-connection-reaper[quarkus.secretsmanager.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -779,6 +837,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.tcp-keep-alive[quarkus.secretsmanager.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.enabled[quarkus.secretsmanager.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.endpoint[quarkus.secretsmanager.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -830,6 +891,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.username]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.username[quarkus.secretsmanager.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.password]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.password[quarkus.secretsmanager.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.ntlm-domain[quarkus.secretsmanager.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.ntlm-workstation[quarkus.secretsmanager.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.secretsmanager.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.sync-client.apache.proxy.non-proxy-hosts[quarkus.secretsmanager.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -931,6 +998,7 @@ h|Default a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.max-concurrency]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.max-concurrency[quarkus.secretsmanager.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -949,6 +1017,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.max-pending-connection-acquires[quarkus.secretsmanager.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -967,6 +1036,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.read-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.read-timeout[quarkus.secretsmanager.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -986,6 +1056,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.write-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.write-timeout[quarkus.secretsmanager.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1005,6 +1076,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connection-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connection-timeout[quarkus.secretsmanager.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1022,6 +1094,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connection-acquisition-timeout[quarkus.secretsmanager.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. @@ -1039,6 +1112,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connection-time-to-live]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connection-time-to-live[quarkus.secretsmanager.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1056,6 +1130,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connection-max-idle-time]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.connection-max-idle-time[quarkus.secretsmanager.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1075,6 +1150,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.use-idle-connection-reaper[quarkus.secretsmanager.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1093,6 +1169,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tcp-keep-alive]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tcp-keep-alive[quarkus.secretsmanager.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.protocol]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.protocol[quarkus.secretsmanager.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1126,6 +1204,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.ssl-provider]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.ssl-provider[quarkus.secretsmanager.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1145,6 +1224,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.http2.max-streams]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.http2.max-streams[quarkus.secretsmanager.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1163,6 +1243,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.http2.initial-window-size]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.http2.initial-window-size[quarkus.secretsmanager.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1181,6 +1262,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.http2.health-check-ping-period[quarkus.secretsmanager.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1200,6 +1282,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.proxy.enabled]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.proxy.enabled[quarkus.secretsmanager.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.proxy.endpoint]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.proxy.endpoint[quarkus.secretsmanager.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1235,6 +1319,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.proxy.non-proxy-hosts[quarkus.secretsmanager.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-managers-provider.type[quarkus.secretsmanager.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1276,6 +1362,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.path[quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.type[quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1310,6 +1398,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.password[quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust-managers-provider.type[quarkus.secretsmanager.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1351,6 +1441,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.path[quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.type[quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1385,6 +1477,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.password[quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.event-loop.override]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.event-loop.override[quarkus.secretsmanager.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.event-loop.number-of-threads[quarkus.secretsmanager.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1435,6 +1530,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.event-loop.thread-name-prefix[quarkus.secretsmanager.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1455,6 +1551,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-secretsmanager_quarkus.secretsmanager.async-client.advanced.use-future-completion-thread-pool[quarkus.secretsmanager.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc index ba81efb1c..657ad006d 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus.ses.interceptors]]`link:#quarkus-amazon-ses_quarkus.ses.interceptors[quarkus.ses.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus.ses.sync-client.type]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.type[quarkus.ses.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus.ses.async-client.type]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.type[quarkus.ses.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus.ses.devservices.enabled]]`link:#quarkus-amazon-ses_quarkus.ses.devservices.enabled[quarkus.ses.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus.ses.devservices.shared]]`link:#quarkus-amazon-ses_quarkus.ses.devservices.shared[quarkus.ses.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus.ses.devservices.service-name]]`link:#quarkus-amazon-ses_quarkus.ses.devservices.service-name[quarkus.ses.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus.ses.devservices.container-properties-container-properties]]`link:#quarkus-amazon-ses_quarkus.ses.devservices.container-properties-container-properties[quarkus.ses.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -139,6 +146,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.endpoint-override]]`link:#quarkus-amazon-ses_quarkus.ses.endpoint-override[quarkus.ses.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -158,6 +166,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.api-call-timeout]]`link:#quarkus-amazon-ses_quarkus.ses.api-call-timeout[quarkus.ses.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -179,6 +188,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.api-call-attempt-timeout]]`link:#quarkus-amazon-ses_quarkus.ses.api-call-attempt-timeout[quarkus.ses.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -196,6 +206,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-ses_quarkus.ses.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-ses_quarkus.ses.advanced.use-quarkus-scheduled-executor-service[quarkus.ses.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-ses_quarkus.ses.aws-aws-services-configurations]]link:#quarkus-amazon-ses_quarkus.ses.aws-aws-services-configurations[AWS services configurations] h|Type @@ -203,6 +232,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.aws.region]]`link:#quarkus-amazon-ses_quarkus.ses.aws.region[quarkus.ses.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -230,6 +260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.type]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.type[quarkus.ses.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -275,6 +306,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.default-provider.async-credential-update-enabled[quarkus.ses.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -293,6 +325,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.ses.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -316,6 +349,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.static-provider.access-key-id[quarkus.ses.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -332,6 +366,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.static-provider.secret-access-key[quarkus.ses.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.static-provider.session-token[quarkus.ses.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -369,6 +405,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.profile-provider.profile-name[quarkus.ses.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -392,6 +429,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.async-credential-update-enabled[quarkus.ses.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -410,6 +448,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.credential-refresh-threshold[quarkus.ses.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -429,6 +468,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.process-output-limit[quarkus.ses.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.command]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.process-provider.command[quarkus.ses.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -466,6 +507,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-ses_quarkus.ses.aws.credentials.custom-provider.name[quarkus.ses.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -487,6 +529,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.sync-client.connection-timeout]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.connection-timeout[quarkus.ses.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -504,6 +547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.socket-timeout]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.socket-timeout[quarkus.ses.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -521,6 +565,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.type[quarkus.ses.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -546,6 +591,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.file-store.path[quarkus.ses.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.file-store.type[quarkus.ses.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -580,6 +627,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.tls-key-managers-provider.file-store.password[quarkus.ses.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.type[quarkus.ses.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -621,6 +670,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.file-store.path[quarkus.ses.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.file-store.type[quarkus.ses.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -655,6 +706,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.tls-trust-managers-provider.file-store.password[quarkus.ses.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -676,6 +728,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.connection-acquisition-timeout[quarkus.ses.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -693,6 +746,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.connection-max-idle-time[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. @@ -710,6 +764,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.connection-time-to-live[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. @@ -727,6 +782,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.max-connections]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.max-connections[quarkus.ses.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -745,6 +801,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.expect-continue-enabled[quarkus.ses.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.use-idle-connection-reaper[quarkus.ses.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -779,6 +837,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.tcp-keep-alive[quarkus.ses.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.enabled[quarkus.ses.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.endpoint[quarkus.ses.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -830,6 +891,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.username]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.username[quarkus.ses.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.password]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.password[quarkus.ses.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.ntlm-domain[quarkus.ses.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.ntlm-workstation[quarkus.ses.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.ses.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-ses_quarkus.ses.sync-client.apache.proxy.non-proxy-hosts[quarkus.ses.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -931,6 +998,7 @@ h|Default a| [[quarkus-amazon-ses_quarkus.ses.async-client.max-concurrency]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.max-concurrency[quarkus.ses.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -949,6 +1017,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.max-pending-connection-acquires[quarkus.ses.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -967,6 +1036,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.read-timeout]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.read-timeout[quarkus.ses.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -986,6 +1056,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.write-timeout]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.write-timeout[quarkus.ses.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1005,6 +1076,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.connection-timeout]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.connection-timeout[quarkus.ses.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1022,6 +1094,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.connection-acquisition-timeout[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. @@ -1039,6 +1112,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.connection-time-to-live]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.connection-time-to-live[quarkus.ses.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1056,6 +1130,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.connection-max-idle-time]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.connection-max-idle-time[quarkus.ses.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1075,6 +1150,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.use-idle-connection-reaper[quarkus.ses.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1093,6 +1169,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.tcp-keep-alive]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.tcp-keep-alive[quarkus.ses.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.protocol]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.protocol[quarkus.ses.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1126,6 +1204,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.ssl-provider]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.ssl-provider[quarkus.ses.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1145,6 +1224,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.http2.max-streams]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.http2.max-streams[quarkus.ses.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1163,6 +1243,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.http2.initial-window-size]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.http2.initial-window-size[quarkus.ses.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1181,6 +1262,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.http2.health-check-ping-period[quarkus.ses.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1200,6 +1282,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.proxy.enabled]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.proxy.enabled[quarkus.ses.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.proxy.endpoint]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.proxy.endpoint[quarkus.ses.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1235,6 +1319,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.proxy.non-proxy-hosts[quarkus.ses.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.type[quarkus.ses.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1276,6 +1362,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.file-store.path[quarkus.ses.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.file-store.type[quarkus.ses.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1310,6 +1398,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.tls-key-managers-provider.file-store.password[quarkus.ses.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.type[quarkus.ses.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1351,6 +1441,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.file-store.path[quarkus.ses.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.file-store.type[quarkus.ses.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1385,6 +1477,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.tls-trust-managers-provider.file-store.password[quarkus.ses.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.event-loop.override]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.event-loop.override[quarkus.ses.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.event-loop.number-of-threads[quarkus.ses.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1435,6 +1530,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.event-loop.thread-name-prefix[quarkus.ses.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1455,6 +1551,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ses_quarkus.ses.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-ses_quarkus.ses.async-client.advanced.use-future-completion-thread-pool[quarkus.ses.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc index 9938eb87a..f9dfaaaff 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus.sns.interceptors]]`link:#quarkus-amazon-sns_quarkus.sns.interceptors[quarkus.sns.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus.sns.sync-client.type]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.type[quarkus.sns.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus.sns.async-client.type]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.type[quarkus.sns.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus.sns.devservices.enabled]]`link:#quarkus-amazon-sns_quarkus.sns.devservices.enabled[quarkus.sns.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus.sns.devservices.shared]]`link:#quarkus-amazon-sns_quarkus.sns.devservices.shared[quarkus.sns.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus.sns.devservices.service-name]]`link:#quarkus-amazon-sns_quarkus.sns.devservices.service-name[quarkus.sns.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus.sns.devservices.container-properties-container-properties]]`link:#quarkus-amazon-sns_quarkus.sns.devservices.container-properties-container-properties[quarkus.sns.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -139,6 +146,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.endpoint-override]]`link:#quarkus-amazon-sns_quarkus.sns.endpoint-override[quarkus.sns.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -158,6 +166,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.api-call-timeout]]`link:#quarkus-amazon-sns_quarkus.sns.api-call-timeout[quarkus.sns.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -179,6 +188,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.api-call-attempt-timeout]]`link:#quarkus-amazon-sns_quarkus.sns.api-call-attempt-timeout[quarkus.sns.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -196,6 +206,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-sns_quarkus.sns.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-sns_quarkus.sns.advanced.use-quarkus-scheduled-executor-service[quarkus.sns.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-sns_quarkus.sns.aws-aws-services-configurations]]link:#quarkus-amazon-sns_quarkus.sns.aws-aws-services-configurations[AWS services configurations] h|Type @@ -203,6 +232,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.aws.region]]`link:#quarkus-amazon-sns_quarkus.sns.aws.region[quarkus.sns.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -230,6 +260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.type]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.type[quarkus.sns.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -275,6 +306,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.default-provider.async-credential-update-enabled[quarkus.sns.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -293,6 +325,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.sns.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -316,6 +349,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.static-provider.access-key-id[quarkus.sns.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -332,6 +366,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.static-provider.secret-access-key[quarkus.sns.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.static-provider.session-token[quarkus.sns.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -369,6 +405,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.profile-provider.profile-name[quarkus.sns.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -392,6 +429,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.async-credential-update-enabled[quarkus.sns.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -410,6 +448,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.credential-refresh-threshold[quarkus.sns.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -429,6 +468,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.process-output-limit[quarkus.sns.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.command]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.process-provider.command[quarkus.sns.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -466,6 +507,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-sns_quarkus.sns.aws.credentials.custom-provider.name[quarkus.sns.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -487,6 +529,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.sync-client.connection-timeout]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.connection-timeout[quarkus.sns.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -504,6 +547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.socket-timeout]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.socket-timeout[quarkus.sns.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -521,6 +565,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.type[quarkus.sns.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -546,6 +591,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.file-store.path[quarkus.sns.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.file-store.type[quarkus.sns.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -580,6 +627,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.tls-key-managers-provider.file-store.password[quarkus.sns.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.type[quarkus.sns.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -621,6 +670,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.file-store.path[quarkus.sns.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.file-store.type[quarkus.sns.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -655,6 +706,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.tls-trust-managers-provider.file-store.password[quarkus.sns.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -676,6 +728,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.connection-acquisition-timeout[quarkus.sns.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -693,6 +746,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.connection-max-idle-time[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. @@ -710,6 +764,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.connection-time-to-live[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. @@ -727,6 +782,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.max-connections]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.max-connections[quarkus.sns.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -745,6 +801,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.expect-continue-enabled[quarkus.sns.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.use-idle-connection-reaper[quarkus.sns.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -779,6 +837,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.tcp-keep-alive[quarkus.sns.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.enabled[quarkus.sns.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.endpoint[quarkus.sns.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -830,6 +891,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.username]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.username[quarkus.sns.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.password]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.password[quarkus.sns.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.ntlm-domain[quarkus.sns.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.ntlm-workstation[quarkus.sns.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.sns.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-sns_quarkus.sns.sync-client.apache.proxy.non-proxy-hosts[quarkus.sns.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -931,6 +998,7 @@ h|Default a| [[quarkus-amazon-sns_quarkus.sns.async-client.max-concurrency]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.max-concurrency[quarkus.sns.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -949,6 +1017,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.max-pending-connection-acquires[quarkus.sns.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -967,6 +1036,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.read-timeout]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.read-timeout[quarkus.sns.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -986,6 +1056,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.write-timeout]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.write-timeout[quarkus.sns.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1005,6 +1076,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.connection-timeout]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.connection-timeout[quarkus.sns.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1022,6 +1094,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.connection-acquisition-timeout[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. @@ -1039,6 +1112,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.connection-time-to-live]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.connection-time-to-live[quarkus.sns.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1056,6 +1130,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.connection-max-idle-time]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.connection-max-idle-time[quarkus.sns.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1075,6 +1150,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.use-idle-connection-reaper[quarkus.sns.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1093,6 +1169,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.tcp-keep-alive]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.tcp-keep-alive[quarkus.sns.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.protocol]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.protocol[quarkus.sns.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1126,6 +1204,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.ssl-provider]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.ssl-provider[quarkus.sns.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1145,6 +1224,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.http2.max-streams]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.http2.max-streams[quarkus.sns.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1163,6 +1243,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.http2.initial-window-size]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.http2.initial-window-size[quarkus.sns.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1181,6 +1262,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.http2.health-check-ping-period[quarkus.sns.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1200,6 +1282,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.proxy.enabled]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.proxy.enabled[quarkus.sns.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.proxy.endpoint]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.proxy.endpoint[quarkus.sns.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1235,6 +1319,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.proxy.non-proxy-hosts[quarkus.sns.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.type[quarkus.sns.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1276,6 +1362,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.file-store.path[quarkus.sns.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.file-store.type[quarkus.sns.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1310,6 +1398,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.tls-key-managers-provider.file-store.password[quarkus.sns.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.type[quarkus.sns.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1351,6 +1441,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.file-store.path[quarkus.sns.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.file-store.type[quarkus.sns.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1385,6 +1477,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.tls-trust-managers-provider.file-store.password[quarkus.sns.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.event-loop.override]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.event-loop.override[quarkus.sns.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.event-loop.number-of-threads[quarkus.sns.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1435,6 +1530,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.event-loop.thread-name-prefix[quarkus.sns.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1455,6 +1551,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sns_quarkus.sns.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-sns_quarkus.sns.async-client.advanced.use-future-completion-thread-pool[quarkus.sns.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc index b2d5feb94..d24dc856a 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.interceptors]]`link:#quarkus-amazon-sqs_quarkus.sqs.interceptors[quarkus.sqs.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.sync-client.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.type[quarkus.sqs.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.async-client.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.type[quarkus.sqs.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.devservices.enabled]]`link:#quarkus-amazon-sqs_quarkus.sqs.devservices.enabled[quarkus.sqs.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.devservices.shared]]`link:#quarkus-amazon-sqs_quarkus.sqs.devservices.shared[quarkus.sqs.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.devservices.service-name]]`link:#quarkus-amazon-sqs_quarkus.sqs.devservices.service-name[quarkus.sqs.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.devservices.queues]]`link:#quarkus-amazon-sqs_quarkus.sqs.devservices.queues[quarkus.sqs.devservices.queues]` + [.description] -- The queues to create on startup. @@ -134,6 +141,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus.sqs.devservices.container-properties-container-properties]]`link:#quarkus-amazon-sqs_quarkus.sqs.devservices.container-properties-container-properties[quarkus.sqs.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -155,6 +163,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.endpoint-override]]`link:#quarkus-amazon-sqs_quarkus.sqs.endpoint-override[quarkus.sqs.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -174,6 +183,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.api-call-timeout]]`link:#quarkus-amazon-sqs_quarkus.sqs.api-call-timeout[quarkus.sqs.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -195,6 +205,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.api-call-attempt-timeout]]`link:#quarkus-amazon-sqs_quarkus.sqs.api-call-attempt-timeout[quarkus.sqs.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -212,6 +223,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-sqs_quarkus.sqs.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-sqs_quarkus.sqs.advanced.use-quarkus-scheduled-executor-service[quarkus.sqs.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-sqs_quarkus.sqs.aws-aws-services-configurations]]link:#quarkus-amazon-sqs_quarkus.sqs.aws-aws-services-configurations[AWS services configurations] h|Type @@ -219,6 +249,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.aws.region]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.region[quarkus.sqs.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -246,6 +277,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.type[quarkus.sqs.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -291,6 +323,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.default-provider.async-credential-update-enabled[quarkus.sqs.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -309,6 +342,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.sqs.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -332,6 +366,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.static-provider.access-key-id[quarkus.sqs.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.static-provider.secret-access-key[quarkus.sqs.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -364,6 +400,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.static-provider.session-token[quarkus.sqs.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -385,6 +422,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.profile-provider.profile-name[quarkus.sqs.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -408,6 +446,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.async-credential-update-enabled[quarkus.sqs.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -426,6 +465,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.credential-refresh-threshold[quarkus.sqs.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.process-output-limit[quarkus.sqs.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -461,6 +502,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.command]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.process-provider.command[quarkus.sqs.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -482,6 +524,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-sqs_quarkus.sqs.aws.credentials.custom-provider.name[quarkus.sqs.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -503,6 +546,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.connection-timeout]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.connection-timeout[quarkus.sqs.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -520,6 +564,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.socket-timeout]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.socket-timeout[quarkus.sqs.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -537,6 +582,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.type[quarkus.sqs.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.file-store.path[quarkus.sqs.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -578,6 +625,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.file-store.type[quarkus.sqs.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-key-managers-provider.file-store.password[quarkus.sqs.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -612,6 +661,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.type[quarkus.sqs.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.path[quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -653,6 +704,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.type[quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -671,6 +723,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.password[quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -692,6 +745,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.connection-acquisition-timeout[quarkus.sqs.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -709,6 +763,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.connection-max-idle-time[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. @@ -726,6 +781,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.connection-time-to-live[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. @@ -743,6 +799,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.max-connections]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.max-connections[quarkus.sqs.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.expect-continue-enabled[quarkus.sqs.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -777,6 +835,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.use-idle-connection-reaper[quarkus.sqs.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.tcp-keep-alive[quarkus.sqs.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.enabled[quarkus.sqs.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -827,6 +888,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.endpoint[quarkus.sqs.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.username]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.username[quarkus.sqs.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.password]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.password[quarkus.sqs.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.ntlm-domain[quarkus.sqs.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.ntlm-workstation[quarkus.sqs.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.sqs.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -926,6 +993,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-sqs_quarkus.sqs.sync-client.apache.proxy.non-proxy-hosts[quarkus.sqs.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -947,6 +1015,7 @@ h|Default a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.max-concurrency]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.max-concurrency[quarkus.sqs.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -965,6 +1034,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.max-pending-connection-acquires[quarkus.sqs.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -983,6 +1053,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.read-timeout]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.read-timeout[quarkus.sqs.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -1002,6 +1073,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.write-timeout]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.write-timeout[quarkus.sqs.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1021,6 +1093,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.connection-timeout]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.connection-timeout[quarkus.sqs.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1038,6 +1111,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.connection-acquisition-timeout[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. @@ -1055,6 +1129,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.connection-time-to-live]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.connection-time-to-live[quarkus.sqs.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1072,6 +1147,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.connection-max-idle-time]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.connection-max-idle-time[quarkus.sqs.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1091,6 +1167,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.use-idle-connection-reaper[quarkus.sqs.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tcp-keep-alive]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.tcp-keep-alive[quarkus.sqs.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1125,6 +1203,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.protocol]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.protocol[quarkus.sqs.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1142,6 +1221,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.ssl-provider]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.ssl-provider[quarkus.sqs.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1161,6 +1241,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.http2.max-streams]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.http2.max-streams[quarkus.sqs.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1179,6 +1260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.http2.initial-window-size]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.http2.initial-window-size[quarkus.sqs.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1197,6 +1279,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.http2.health-check-ping-period[quarkus.sqs.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.proxy.enabled]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.proxy.enabled[quarkus.sqs.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1232,6 +1316,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.proxy.endpoint]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.proxy.endpoint[quarkus.sqs.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.proxy.non-proxy-hosts[quarkus.sqs.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1267,6 +1353,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.type[quarkus.sqs.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.file-store.path[quarkus.sqs.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1308,6 +1396,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.file-store.type[quarkus.sqs.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.tls-key-managers-provider.file-store.password[quarkus.sqs.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1342,6 +1432,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.type[quarkus.sqs.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.file-store.path[quarkus.sqs.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1383,6 +1475,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.file-store.type[quarkus.sqs.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.tls-trust-managers-provider.file-store.password[quarkus.sqs.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.event-loop.override]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.event-loop.override[quarkus.sqs.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1433,6 +1528,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.event-loop.number-of-threads[quarkus.sqs.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1451,6 +1547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.event-loop.thread-name-prefix[quarkus.sqs.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1471,6 +1568,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sqs_quarkus.sqs.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-sqs_quarkus.sqs.async-client.advanced.use-future-completion-thread-pool[quarkus.sqs.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc index 8c370526f..f30345691 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus.ssm.interceptors]]`link:#quarkus-amazon-ssm_quarkus.ssm.interceptors[quarkus.ssm.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus.ssm.sync-client.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.type[quarkus.ssm.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus.ssm.async-client.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.type[quarkus.ssm.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus.ssm.devservices.enabled]]`link:#quarkus-amazon-ssm_quarkus.ssm.devservices.enabled[quarkus.ssm.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus.ssm.devservices.shared]]`link:#quarkus-amazon-ssm_quarkus.ssm.devservices.shared[quarkus.ssm.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus.ssm.devservices.service-name]]`link:#quarkus-amazon-ssm_quarkus.ssm.devservices.service-name[quarkus.ssm.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus.ssm.devservices.container-properties-container-properties]]`link:#quarkus-amazon-ssm_quarkus.ssm.devservices.container-properties-container-properties[quarkus.ssm.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -139,6 +146,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.endpoint-override]]`link:#quarkus-amazon-ssm_quarkus.ssm.endpoint-override[quarkus.ssm.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -158,6 +166,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.api-call-timeout]]`link:#quarkus-amazon-ssm_quarkus.ssm.api-call-timeout[quarkus.ssm.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -179,6 +188,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.api-call-attempt-timeout]]`link:#quarkus-amazon-ssm_quarkus.ssm.api-call-attempt-timeout[quarkus.ssm.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -196,6 +206,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-ssm_quarkus.ssm.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-ssm_quarkus.ssm.advanced.use-quarkus-scheduled-executor-service[quarkus.ssm.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-ssm_quarkus.ssm.aws-aws-services-configurations]]link:#quarkus-amazon-ssm_quarkus.ssm.aws-aws-services-configurations[AWS services configurations] h|Type @@ -203,6 +232,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.aws.region]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.region[quarkus.ssm.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -230,6 +260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.type[quarkus.ssm.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -275,6 +306,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.default-provider.async-credential-update-enabled[quarkus.ssm.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -293,6 +325,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.ssm.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -316,6 +349,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.static-provider.access-key-id[quarkus.ssm.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -332,6 +366,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.static-provider.secret-access-key[quarkus.ssm.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.static-provider.session-token[quarkus.ssm.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -369,6 +405,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.profile-provider.profile-name[quarkus.ssm.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -392,6 +429,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.async-credential-update-enabled[quarkus.ssm.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -410,6 +448,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.credential-refresh-threshold[quarkus.ssm.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -429,6 +468,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.process-output-limit[quarkus.ssm.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.command]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.process-provider.command[quarkus.ssm.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -466,6 +507,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-ssm_quarkus.ssm.aws.credentials.custom-provider.name[quarkus.ssm.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -487,6 +529,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.connection-timeout]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.connection-timeout[quarkus.ssm.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -504,6 +547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.socket-timeout]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.socket-timeout[quarkus.ssm.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -521,6 +565,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.type[quarkus.ssm.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -546,6 +591,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.file-store.path[quarkus.ssm.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.file-store.type[quarkus.ssm.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -580,6 +627,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-key-managers-provider.file-store.password[quarkus.ssm.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.type[quarkus.ssm.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -621,6 +670,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.path[quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.type[quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -655,6 +706,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.password[quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -676,6 +728,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.connection-acquisition-timeout[quarkus.ssm.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -693,6 +746,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.connection-max-idle-time[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. @@ -710,6 +764,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.connection-time-to-live[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. @@ -727,6 +782,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.max-connections]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.max-connections[quarkus.ssm.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -745,6 +801,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.expect-continue-enabled[quarkus.ssm.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.use-idle-connection-reaper[quarkus.ssm.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -779,6 +837,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.tcp-keep-alive[quarkus.ssm.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.enabled[quarkus.ssm.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.endpoint[quarkus.ssm.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -830,6 +891,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.username]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.username[quarkus.ssm.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.password]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.password[quarkus.ssm.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.ntlm-domain[quarkus.ssm.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.ntlm-workstation[quarkus.ssm.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.ssm.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-ssm_quarkus.ssm.sync-client.apache.proxy.non-proxy-hosts[quarkus.ssm.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -931,6 +998,7 @@ h|Default a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.max-concurrency]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.max-concurrency[quarkus.ssm.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -949,6 +1017,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.max-pending-connection-acquires[quarkus.ssm.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -967,6 +1036,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.read-timeout]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.read-timeout[quarkus.ssm.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -986,6 +1056,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.write-timeout]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.write-timeout[quarkus.ssm.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1005,6 +1076,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.connection-timeout]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.connection-timeout[quarkus.ssm.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1022,6 +1094,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.connection-acquisition-timeout[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. @@ -1039,6 +1112,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.connection-time-to-live]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.connection-time-to-live[quarkus.ssm.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1056,6 +1130,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.connection-max-idle-time]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.connection-max-idle-time[quarkus.ssm.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1075,6 +1150,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.use-idle-connection-reaper[quarkus.ssm.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1093,6 +1169,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tcp-keep-alive]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.tcp-keep-alive[quarkus.ssm.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.protocol]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.protocol[quarkus.ssm.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1126,6 +1204,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.ssl-provider]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.ssl-provider[quarkus.ssm.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1145,6 +1224,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.http2.max-streams]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.http2.max-streams[quarkus.ssm.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1163,6 +1243,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.http2.initial-window-size]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.http2.initial-window-size[quarkus.ssm.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1181,6 +1262,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.http2.health-check-ping-period[quarkus.ssm.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1200,6 +1282,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.proxy.enabled]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.proxy.enabled[quarkus.ssm.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.proxy.endpoint]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.proxy.endpoint[quarkus.ssm.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1235,6 +1319,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.proxy.non-proxy-hosts[quarkus.ssm.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.type[quarkus.ssm.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1276,6 +1362,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.file-store.path[quarkus.ssm.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.file-store.type[quarkus.ssm.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1310,6 +1398,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.tls-key-managers-provider.file-store.password[quarkus.ssm.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.type[quarkus.ssm.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1351,6 +1441,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.file-store.path[quarkus.ssm.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.file-store.type[quarkus.ssm.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1385,6 +1477,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.tls-trust-managers-provider.file-store.password[quarkus.ssm.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.event-loop.override]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.event-loop.override[quarkus.ssm.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.event-loop.number-of-threads[quarkus.ssm.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1435,6 +1530,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.event-loop.thread-name-prefix[quarkus.ssm.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1455,6 +1551,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-ssm_quarkus.ssm.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-ssm_quarkus.ssm.async-client.advanced.use-future-completion-thread-pool[quarkus.ssm.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sts.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sts.adoc index bb296a2e2..60af0bce5 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-sts.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sts.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus.sts.interceptors]]`link:#quarkus-amazon-sts_quarkus.sts.interceptors[quarkus.sts.interceptors]` + [.description] -- 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. @@ -30,6 +31,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus.sts.sync-client.type]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.type[quarkus.sts.sync-client.type]` + [.description] -- Type of the sync HTTP client implementation @@ -47,6 +49,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus.sts.async-client.type]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.type[quarkus.sts.async-client.type]` + [.description] -- Type of the async HTTP client implementation @@ -64,6 +67,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus.sts.devservices.enabled]]`link:#quarkus-amazon-sts_quarkus.sts.devservices.enabled[quarkus.sts.devservices.enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -80,6 +84,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus.sts.devservices.shared]]`link:#quarkus-amazon-sts_quarkus.sts.devservices.shared[quarkus.sts.devservices.shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -100,6 +105,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus.sts.devservices.service-name]]`link:#quarkus-amazon-sts_quarkus.sts.devservices.service-name[quarkus.sts.devservices.service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -118,6 +124,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus.sts.devservices.container-properties-container-properties]]`link:#quarkus-amazon-sts_quarkus.sts.devservices.container-properties-container-properties[quarkus.sts.devservices.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -139,6 +146,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.endpoint-override]]`link:#quarkus-amazon-sts_quarkus.sts.endpoint-override[quarkus.sts.endpoint-override]` + [.description] -- The endpoint URI with which the SDK should communicate. @@ -158,6 +166,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.api-call-timeout]]`link:#quarkus-amazon-sts_quarkus.sts.api-call-timeout[quarkus.sts.api-call-timeout]` + [.description] -- The amount of time to allow the client to complete the execution of an API call. @@ -179,6 +188,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.api-call-attempt-timeout]]`link:#quarkus-amazon-sts_quarkus.sts.api-call-attempt-timeout[quarkus.sts.api-call-attempt-timeout]` + [.description] -- The amount of time to wait for the HTTP request to complete before giving up and timing out. @@ -196,6 +206,25 @@ endif::add-copy-button-to-env-var[] | +a| [[quarkus-amazon-sts_quarkus.sts.advanced.use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-sts_quarkus.sts.advanced.use-quarkus-scheduled-executor-service[quarkus.sts.advanced.use-quarkus-scheduled-executor-service]` + + +[.description] +-- +Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. + +When disabled, the default sdk behavior is to create a dedicated thread pool for each client, resulting in competition for CPU resources among these thread pools. + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +--|boolean +|`true` + + h|[[quarkus-amazon-sts_quarkus.sts.aws-aws-services-configurations]]link:#quarkus-amazon-sts_quarkus.sts.aws-aws-services-configurations[AWS services configurations] h|Type @@ -203,6 +232,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.aws.region]]`link:#quarkus-amazon-sts_quarkus.sts.aws.region[quarkus.sts.aws.region]` + [.description] -- An Amazon Web Services region that hosts the given service. @@ -230,6 +260,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.type]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.type[quarkus.sts.aws.credentials.type]` + [.description] -- Configure the credentials provider that should be used to authenticate with AWS. @@ -275,6 +306,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.default-provider.async-credential-update-enabled]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.default-provider.async-credential-update-enabled[quarkus.sts.aws.credentials.default-provider.async-credential-update-enabled]` + [.description] -- Whether this provider should fetch credentials asynchronously in the background. @@ -293,6 +325,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.default-provider.reuse-last-provider-enabled]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.default-provider.reuse-last-provider-enabled[quarkus.sts.aws.credentials.default-provider.reuse-last-provider-enabled]` + [.description] -- Whether the provider should reuse the last successful credentials provider in the chain. @@ -316,6 +349,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.static-provider.access-key-id]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.static-provider.access-key-id[quarkus.sts.aws.credentials.static-provider.access-key-id]` + [.description] -- AWS Access key id @@ -332,6 +366,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.static-provider.secret-access-key]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.static-provider.secret-access-key[quarkus.sts.aws.credentials.static-provider.secret-access-key]` + [.description] -- AWS Secret access key @@ -348,6 +383,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.static-provider.session-token]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.static-provider.session-token[quarkus.sts.aws.credentials.static-provider.session-token]` + [.description] -- AWS Session token @@ -369,6 +405,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.profile-provider.profile-name]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.profile-provider.profile-name[quarkus.sts.aws.credentials.profile-provider.profile-name]` + [.description] -- The name of the profile that should be used by this credentials provider. @@ -392,6 +429,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.process-provider.async-credential-update-enabled]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.process-provider.async-credential-update-enabled[quarkus.sts.aws.credentials.process-provider.async-credential-update-enabled]` + [.description] -- Whether the provider should fetch credentials asynchronously in the background. @@ -410,6 +448,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.process-provider.credential-refresh-threshold]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.process-provider.credential-refresh-threshold[quarkus.sts.aws.credentials.process-provider.credential-refresh-threshold]` + [.description] -- The amount of time between when the credentials expire and when the credentials should start to be refreshed. @@ -429,6 +468,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.process-provider.process-output-limit]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.process-provider.process-output-limit[quarkus.sts.aws.credentials.process-provider.process-output-limit]` + [.description] -- The maximum size of the output that can be returned by the external process before an exception is raised. @@ -445,6 +485,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.process-provider.command]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.process-provider.command[quarkus.sts.aws.credentials.process-provider.command]` + [.description] -- The command that should be executed to retrieve credentials. @@ -466,6 +507,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.aws.credentials.custom-provider.name]]`link:#quarkus-amazon-sts_quarkus.sts.aws.credentials.custom-provider.name[quarkus.sts.aws.credentials.custom-provider.name]` + [.description] -- The name of custom AwsCredentialsProvider bean. @@ -487,6 +529,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.sync-client.connection-timeout]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.connection-timeout[quarkus.sts.sync-client.connection-timeout]` + [.description] -- The maximum amount of time to establish a connection before timing out. @@ -504,6 +547,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.socket-timeout]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.socket-timeout[quarkus.sts.sync-client.socket-timeout]` + [.description] -- The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. @@ -521,6 +565,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.tls-key-managers-provider.type[quarkus.sts.sync-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -546,6 +591,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.tls-key-managers-provider.file-store.path[quarkus.sts.sync-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -562,6 +608,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.tls-key-managers-provider.file-store.type[quarkus.sts.sync-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -580,6 +627,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.tls-key-managers-provider.file-store.password[quarkus.sts.sync-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -596,6 +644,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.tls-trust-managers-provider.type[quarkus.sts.sync-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -621,6 +670,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.tls-trust-managers-provider.file-store.path[quarkus.sts.sync-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -637,6 +687,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.tls-trust-managers-provider.file-store.type[quarkus.sts.sync-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -655,6 +706,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.tls-trust-managers-provider.file-store.password[quarkus.sts.sync-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -676,6 +728,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.connection-acquisition-timeout]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.connection-acquisition-timeout[quarkus.sts.sync-client.apache.connection-acquisition-timeout]` + [.description] -- The amount of time to wait when acquiring a connection from the pool before giving up and timing out. @@ -693,6 +746,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.connection-max-idle-time]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.connection-max-idle-time[quarkus.sts.sync-client.apache.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -710,6 +764,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.connection-time-to-live]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.connection-time-to-live[quarkus.sts.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. @@ -727,6 +782,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.max-connections]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.max-connections[quarkus.sts.sync-client.apache.max-connections]` + [.description] -- The maximum number of connections allowed in the connection pool. @@ -745,6 +801,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.expect-continue-enabled]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.expect-continue-enabled[quarkus.sts.sync-client.apache.expect-continue-enabled]` + [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. @@ -761,6 +818,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.use-idle-connection-reaper]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.use-idle-connection-reaper[quarkus.sts.sync-client.apache.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed asynchronously. @@ -779,6 +837,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.tcp-keep-alive]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.tcp-keep-alive[quarkus.sts.sync-client.apache.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -795,6 +854,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.enabled]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.enabled[quarkus.sts.sync-client.apache.proxy.enabled]` + [.description] -- Enable HTTP proxy @@ -811,6 +871,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.endpoint]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.endpoint[quarkus.sts.sync-client.apache.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -830,6 +891,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.username]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.username[quarkus.sts.sync-client.apache.proxy.username]` + [.description] -- The username to use when connecting through a proxy. @@ -846,6 +908,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.password]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.password[quarkus.sts.sync-client.apache.proxy.password]` + [.description] -- The password to use when connecting through a proxy. @@ -862,6 +925,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.ntlm-domain]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.ntlm-domain[quarkus.sts.sync-client.apache.proxy.ntlm-domain]` + [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. @@ -878,6 +942,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.ntlm-workstation]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.ntlm-workstation[quarkus.sts.sync-client.apache.proxy.ntlm-workstation]` + [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. @@ -894,6 +959,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.preemptive-basic-authentication-enabled[quarkus.sts.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` + [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. @@ -910,6 +976,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.non-proxy-hosts]]`link:#quarkus-amazon-sts_quarkus.sts.sync-client.apache.proxy.non-proxy-hosts[quarkus.sts.sync-client.apache.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -931,6 +998,7 @@ h|Default a| [[quarkus-amazon-sts_quarkus.sts.async-client.max-concurrency]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.max-concurrency[quarkus.sts.async-client.max-concurrency]` + [.description] -- The maximum number of allowed concurrent requests. @@ -949,6 +1017,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.max-pending-connection-acquires]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.max-pending-connection-acquires[quarkus.sts.async-client.max-pending-connection-acquires]` + [.description] -- The maximum number of pending acquires allowed. @@ -967,6 +1036,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.read-timeout]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.read-timeout[quarkus.sts.async-client.read-timeout]` + [.description] -- The amount of time to wait for a read on a socket before an exception is thrown. @@ -986,6 +1056,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.write-timeout]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.write-timeout[quarkus.sts.async-client.write-timeout]` + [.description] -- The amount of time to wait for a write on a socket before an exception is thrown. @@ -1005,6 +1076,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.connection-timeout]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.connection-timeout[quarkus.sts.async-client.connection-timeout]` + [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. @@ -1022,6 +1094,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.connection-acquisition-timeout]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.connection-acquisition-timeout[quarkus.sts.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. @@ -1039,6 +1112,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.connection-time-to-live]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.connection-time-to-live[quarkus.sts.async-client.connection-time-to-live]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. @@ -1056,6 +1130,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.connection-max-idle-time]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.connection-max-idle-time[quarkus.sts.async-client.connection-max-idle-time]` + [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. @@ -1075,6 +1150,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.use-idle-connection-reaper]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.use-idle-connection-reaper[quarkus.sts.async-client.use-idle-connection-reaper]` + [.description] -- Whether the idle connections in the connection pool should be closed. @@ -1093,6 +1169,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.tcp-keep-alive]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.tcp-keep-alive[quarkus.sts.async-client.tcp-keep-alive]` + [.description] -- Configure whether to enable or disable TCP KeepAlive. @@ -1109,6 +1186,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.protocol]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.protocol[quarkus.sts.async-client.protocol]` + [.description] -- The HTTP protocol to use. @@ -1126,6 +1204,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.ssl-provider]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.ssl-provider[quarkus.sts.async-client.ssl-provider]` + [.description] -- The SSL Provider to be used in the Netty client. @@ -1145,6 +1224,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.http2.max-streams]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.http2.max-streams[quarkus.sts.async-client.http2.max-streams]` + [.description] -- The maximum number of concurrent streams for an HTTP/2 connection. @@ -1163,6 +1243,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.http2.initial-window-size]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.http2.initial-window-size[quarkus.sts.async-client.http2.initial-window-size]` + [.description] -- The initial window size for an HTTP/2 stream. @@ -1181,6 +1262,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.http2.health-check-ping-period]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.http2.health-check-ping-period[quarkus.sts.async-client.http2.health-check-ping-period]` + [.description] -- 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. @@ -1200,6 +1282,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.proxy.enabled]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.proxy.enabled[quarkus.sts.async-client.proxy.enabled]` + [.description] -- Enable HTTP proxy. @@ -1216,6 +1299,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.proxy.endpoint]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.proxy.endpoint[quarkus.sts.async-client.proxy.endpoint]` + [.description] -- The endpoint of the proxy server that the SDK should connect through. @@ -1235,6 +1319,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.proxy.non-proxy-hosts]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.proxy.non-proxy-hosts[quarkus.sts.async-client.proxy.non-proxy-hosts]` + [.description] -- The hosts that the client is allowed to access without going through the proxy. @@ -1251,6 +1336,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.tls-key-managers-provider.type]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.tls-key-managers-provider.type[quarkus.sts.async-client.tls-key-managers-provider.type]` + [.description] -- TLS key managers provider type. @@ -1276,6 +1362,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.tls-key-managers-provider.file-store.path]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.tls-key-managers-provider.file-store.path[quarkus.sts.async-client.tls-key-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1292,6 +1379,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.tls-key-managers-provider.file-store.type]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.tls-key-managers-provider.file-store.type[quarkus.sts.async-client.tls-key-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1310,6 +1398,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.tls-key-managers-provider.file-store.password]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.tls-key-managers-provider.file-store.password[quarkus.sts.async-client.tls-key-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1326,6 +1415,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.tls-trust-managers-provider.type]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.tls-trust-managers-provider.type[quarkus.sts.async-client.tls-trust-managers-provider.type]` + [.description] -- TLS trust managers provider type. @@ -1351,6 +1441,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.tls-trust-managers-provider.file-store.path]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.tls-trust-managers-provider.file-store.path[quarkus.sts.async-client.tls-trust-managers-provider.file-store.path]` + [.description] -- Path to the key store. @@ -1367,6 +1458,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.tls-trust-managers-provider.file-store.type]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.tls-trust-managers-provider.file-store.type[quarkus.sts.async-client.tls-trust-managers-provider.file-store.type]` + [.description] -- Key store type. @@ -1385,6 +1477,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.tls-trust-managers-provider.file-store.password]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.tls-trust-managers-provider.file-store.password[quarkus.sts.async-client.tls-trust-managers-provider.file-store.password]` + [.description] -- Key store password @@ -1401,6 +1494,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.event-loop.override]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.event-loop.override[quarkus.sts.async-client.event-loop.override]` + [.description] -- Enable the custom configuration of the Netty event loop group. @@ -1417,6 +1511,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.event-loop.number-of-threads]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.event-loop.number-of-threads[quarkus.sts.async-client.event-loop.number-of-threads]` + [.description] -- Number of threads to use for the event loop group. @@ -1435,6 +1530,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.event-loop.thread-name-prefix]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.event-loop.thread-name-prefix[quarkus.sts.async-client.event-loop.thread-name-prefix]` + [.description] -- The thread name prefix for threads created by this thread factory used by event loop group. @@ -1455,6 +1551,7 @@ endif::add-copy-button-to-env-var[] a| [[quarkus-amazon-sts_quarkus.sts.async-client.advanced.use-future-completion-thread-pool]]`link:#quarkus-amazon-sts_quarkus.sts.async-client.advanced.use-future-completion-thread-pool[quarkus.sts.async-client.advanced.use-future-completion-thread-pool]` + [.description] -- Whether the default thread pool should be used to complete the futures returned from the HTTP client request. diff --git a/docs/modules/ROOT/pages/includes/quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config.adoc b/docs/modules/ROOT/pages/includes/quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config.adoc index a7ce7d189..809685ff4 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.image-name]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.image-name[quarkus.aws.devservices.localstack.image-name]` + [.description] -- The LocalStack container image to use. @@ -28,6 +29,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.init-scripts-folder]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.init-scripts-folder[quarkus.aws.devservices.localstack.init-scripts-folder]` + [.description] -- Path to init scripts folder executed during localstack startup. @@ -44,6 +46,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.init-completion-msg]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.init-completion-msg[quarkus.aws.devservices.localstack.init-completion-msg]` + [.description] -- Specific container log message to be waiting for localstack init scripts completion. @@ -60,6 +63,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.container-properties-container-properties]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.container-properties-container-properties[quarkus.aws.devservices.localstack.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. @@ -76,6 +80,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.additional-services.-additional-services-.enabled]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.additional-services.-additional-services-.enabled[quarkus.aws.devservices.localstack.additional-services."additional-services".enabled]` + [.description] -- If a local AWS stack should be used. (default to true) If this is true and endpoint-override is not configured then a local AWS stack will be started and will be used instead of the given configuration. For all services but Cognito, the local AWS stack will be provided by LocalStack. Otherwise, it will be provided by Moto @@ -92,6 +97,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.additional-services.-additional-services-.shared]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.additional-services.-additional-services-.shared[quarkus.aws.devservices.localstack.additional-services."additional-services".shared]` + [.description] -- Indicates if the LocalStack container managed by Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container. @@ -112,6 +118,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.additional-services.-additional-services-.service-name]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.additional-services.-additional-services-.service-name[quarkus.aws.devservices.localstack.additional-services."additional-services".service-name]` + [.description] -- The value of the `quarkus-dev-service-localstack` label attached to the started container. In dev mode, when `shared` is set to `true`, before starting a container, Dev Services looks for a container with the `quarkus-dev-service-localstack` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-localstack` label set to the specified value. In test mode, Dev Services will group services with the same `service-name` value in one container instance. @@ -130,6 +137,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.additional-services.-additional-services-.container-properties-container-properties]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus.aws.devservices.localstack.additional-services.-additional-services-.container-properties-container-properties[quarkus.aws.devservices.localstack.additional-services."additional-services".container-properties]` + [.description] -- Generic properties that are pass for additional container configuration. diff --git a/docs/modules/ROOT/pages/includes/quarkus-aws-devservices-moto-moto-dev-services-build-time-config.adoc b/docs/modules/ROOT/pages/includes/quarkus-aws-devservices-moto-moto-dev-services-build-time-config.adoc index bceb697a3..cc991641e 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-aws-devservices-moto-moto-dev-services-build-time-config.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-aws-devservices-moto-moto-dev-services-build-time-config.adoc @@ -12,6 +12,7 @@ h|Default a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-moto-moto-dev-services-build-time-config_quarkus.aws.devservices.moto.image-name]]`link:#quarkus-aws-devservices-moto-moto-dev-services-build-time-config_quarkus.aws.devservices.moto.image-name[quarkus.aws.devservices.moto.image-name]` + [.description] -- The Moto container image to use. @@ -28,6 +29,7 @@ endif::add-copy-button-to-env-var[] a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-moto-moto-dev-services-build-time-config_quarkus.aws.devservices.moto.container-properties-container-properties]]`link:#quarkus-aws-devservices-moto-moto-dev-services-build-time-config_quarkus.aws.devservices.moto.container-properties-container-properties[quarkus.aws.devservices.moto.container-properties]` + [.description] -- Generic properties that are pass for additional container configuration.